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

python3.8 a1 - docs build requires sphinx 1.7 but uses a 1.8 feature #80188

Closed
asottile mannequin opened this issue Feb 15, 2019 · 4 comments
Closed

python3.8 a1 - docs build requires sphinx 1.7 but uses a 1.8 feature #80188

asottile mannequin opened this issue Feb 15, 2019 · 4 comments
Labels
3.8 only security fixes build The build process and cross-build docs Documentation in the Doc dir

Comments

@asottile
Copy link
Mannequin

asottile mannequin commented Feb 15, 2019

BPO 36007
Nosy @asottile, @Mariatta, @miss-islington
PRs
  • bpo-36007: Bump minimum sphinx version to 1.8 #11887
  • 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 2019-02-15.23:41:42.703>
    created_at = <Date 2019-02-15.22:48:04.636>
    labels = ['build', '3.8', 'docs']
    title = 'python3.8 a1 - docs build requires sphinx 1.7 but uses a 1.8 feature'
    updated_at = <Date 2019-02-15.23:51:48.223>
    user = 'https://github.com/asottile'

    bugs.python.org fields:

    activity = <Date 2019-02-15.23:51:48.223>
    actor = 'Mariatta'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2019-02-15.23:41:42.703>
    closer = 'Mariatta'
    components = ['Build', 'Documentation']
    creation = <Date 2019-02-15.22:48:04.636>
    creator = 'Anthony Sottile'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 36007
    keywords = ['patch']
    message_count = 4.0
    messages = ['335654', '335655', '335658', '335659']
    nosy_count = 4.0
    nosy_names = ['docs@python', 'Anthony Sottile', 'Mariatta', 'miss-islington']
    pr_nums = ['11887']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue36007'
    versions = ['Python 3.8']

    @asottile
    Copy link
    Mannequin Author

    asottile mannequin commented Feb 15, 2019

    doctest `:skipif:` was added in sphinx-doc/sphinx#5273

    Used here: https://github.com/python/cpython/blame/36433221f06d649dbd7e13f5fec948be8ffb90af/Doc/library/turtle.rst#L252-L253

    Sphinx minimum version configured here:

    cpython/Doc/conf.py

    Lines 44 to 45 in 3643322

    # Require Sphinx 1.7 for build.
    needs_sphinx = '1.7'

    Should this be upped to 1.8 or should the :skipif: be removed? My guess is the former, I'd be happy to contribute a patch

    I hit this while packaging 3.8.0a1 for deadsnakes

    @asottile asottile mannequin added the 3.8 only security fixes label Feb 15, 2019
    @asottile asottile mannequin assigned docspython Feb 15, 2019
    @asottile asottile mannequin added build The build process and cross-build docs Documentation in the Doc dir labels Feb 15, 2019
    @Mariatta
    Copy link
    Member

    Let's up the sphinx version.
    Thanks.

    @miss-islington
    Copy link
    Contributor

    New changeset a16ab00 by Miss Islington (bot) (Anthony Sottile) in branch 'master':
    bpo-36007: Bump minimum sphinx version to 1.8 (GH-11887)
    a16ab00

    @Mariatta
    Copy link
    Member

    Thanks!

    @Mariatta Mariatta added the 3.7 (EOL) end of life label Feb 15, 2019
    @Mariatta Mariatta removed the 3.7 (EOL) end of life label Feb 15, 2019
    @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
    Labels
    3.8 only security fixes build The build process and cross-build docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants