Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Sphinx 2.0 will require master_doc variable set in conf.py #79745

Closed
jfbu mannequin opened this issue Dec 22, 2018 · 7 comments
Closed

[DOC] Sphinx 2.0 will require master_doc variable set in conf.py #79745

jfbu mannequin opened this issue Dec 22, 2018 · 7 comments
Labels
docs Documentation in the Doc dir

Comments

@jfbu
Copy link
Mannequin

jfbu mannequin commented Dec 22, 2018

BPO 35564
Nosy @ned-deily, @JulienPalard, @jfbu
PRs
  • bpo-35564: add master_doc='contents' to conf.py #11290
  • [3.7] bpo-35564: add master_doc='contents' to conf.py #12460
  • [3.6] bpo-35564: add master_doc='contents' to conf.py #12461
  • [2.7] bpo-35564: add master_doc='contents' to conf.py #12462
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2018-12-24.15:19:58.368>
created_at = <Date 2018-12-22.21:29:58.597>
labels = ['docs']
title = '[DOC] Sphinx 2.0 will require master_doc variable set in conf.py'
updated_at = <Date 2019-03-20.15:41:39.998>
user = 'https://github.com/jfbu'

    bugs.python.org fields:

    activity = <Date 2019-03-20.15:41:39.998>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-12-24.15:19:58.368>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2018-12-22.21:29:58.597>
creator = 'jfbu'
dependencies = []
files = []
hgrepos = []
issue_num = 35564
keywords = ['patch']
message_count = 7.0
messages = ['332371', '332387', '332388', '332461', '338445', '338446', '338485']
nosy_count = 4.0
nosy_names = ['ned.deily', 'docs@python', 'mdk', 'jfbu']
pr_nums = ['11290', '12460', '12461', '12462']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue35564'
versions = []
    @jfbu
    Copy link
    Mannequin Author

    jfbu mannequin commented Dec 22, 2018

    When building CPython doc with master branch of dev repo of Sphinx (future Sphinx 2.0) one gets this warning:

    WARNING: Since v2.0, Sphinx uses "index" as master_doc by default. Please add "master_doc = 'contents'" to your conf.py.

    Fix will be to do as Sphinx says :)

    @jfbu jfbu mannequin assigned docspython Dec 22, 2018
    @jfbu jfbu mannequin added the docs Documentation in the Doc dir label Dec 22, 2018
    @jfbu
    Copy link
    Mannequin Author

    jfbu mannequin commented Dec 23, 2018

    GitHub PR bpo-11290 has been merged into master

    @jfbu
    Copy link
    Mannequin Author

    jfbu mannequin commented Dec 23, 2018

    sorry for previous message whose text mentioned the GitHub pull request number but this links to bpo issue of that number, of course completely unrelated

    @JulienPalard
    Copy link
    Member

    New changeset fc8284e by Julien Palard (Jean-François B) in branch 'master':
    bpo-35564: add master_doc='contents' to conf.py (GH-11290)
    fc8284e

    @JulienPalard
    Copy link
    Member

    New changeset 756cfd8 by Julien Palard in branch '3.7':
    [3.7] bpo-35564: add master_doc='contents' to conf.py (GH-12460)
    756cfd8

    @JulienPalard
    Copy link
    Member

    New changeset 07b8018 by Julien Palard in branch '2.7':
    [2.7] bpo-35564: add master_doc='contents' to conf.py (GH-12462)
    07b8018

    @ned-deily
    Copy link
    Member

    New changeset 4508bc3 by Ned Deily (Julien Palard) in branch '3.6':
    [3.6] bpo-35564: add master_doc='contents' to conf.py (GH-11290). (GH-12461)
    4508bc3

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @JulienPalard @ned-deily