Description

assignee = None
closed_at = None
created_at = <Date 2021-01-04.01:28:14.798>
labels = ['docs']
title = 'Sphinx conf.py needs_version entry is outdated'
updated_at = <Date 2021-01-08.23:35:42.562>
user = 'https://github.com/timhoffm'

activity = <Date 2021-01-08.23:35:42.562>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-01-04.01:28:14.798>
creator = 'timhoffm'
dependencies = []
files = []
hgrepos = []
issue_num = 42820
keywords = []
message_count = 2.0
messages = ['384305', '384697']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'docs@python', 'mdk', 'timhoffm']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42820'
versions = []

Activity

1. timhoffm commented on Jan 4, 2021

   

   timhoffmmannequin

   on Jan 4, 2021

   MannequinAuthor

   More actions

   The sphinx conf.py entry needs_version=1.8 (

   cpython/Doc/conf.py

   Line 48 in 1470edd

   needs_sphinx = '1.8'

   )

   is not in sync with the doc build requirements (

   cpython/Doc/requirements.txt

   Line 6 in 1470edd

   sphinx==3.2.1

   )

   Possible solutions:
   a) Drop the needs_version config value. It's optional.
   b) Make sure to update both places.
   c) Or at minimum add a comment that needs_version is only a safeguard against very old sphinx versions but is not necessarily sufficient to build.
2. timhoffm

   assigned

   docspython

   on Jan 4, 2021
3. timhoffm

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Jan 4, 2021
4. terryjreedy commented on Jan 8, 2021

   

   terryjreedy

   on Jan 8, 2021

   Member

   More actions

   This is related to bpo-42843, which is about deciding what the min sphinx should be. Since the alternative to 3.2 is some 2.x, 1,8 is certainly wrong.
5. ezio-melotti

   transferred this issue fromon Apr 10, 2022
6. JulienPalard commented on May 9, 2022

   

   JulienPalard

   on May 9, 2022

   Member

   More actions

   This is now related to #92318, the new needs_sphinx is 3.2, cc @sorcio.
7. sorcio commented on May 29, 2022

   

   sorcio

   on May 29, 2022

   Contributor

   More actions

   Since the time of the discussion in #87009, it looks like the mentioned restrictions are now mostly gone:

   • Debian stable now only has Sphinx 3.4.
   • For deadsnakes, the maintainer confirmed that bumping Sphinx version is not an issue anymore.
   • Ubuntu LTS has Sphinx 3.5.
   • RHEL9 has Sphinx 3.4
   • Fedora and Ubuntu were already ok last year
   • SUSE is less clear to me. I think the rolling openSUSE is already using Sphinx 4.5.0 for Python 3.10. But Leap also has a Python 3.10 package which I think still builds doc with Sphinx 2.3.

   Apparently for 3.11 we are clear. Since #92318 was also backported to 3.10, the SUSE package maintainers might appreciate a heads up.

   Reacted by Adam Turner
8. miss-islington

   added a commit that references this issue on Jun 7, 2022

   pythongh-86986: bump min sphinx version to 3.2 (pythonGH-93337)

   5a7da81
9. ambv

   added a commit that references this issue on Jun 7, 2022

   gh-86986: bump min sphinx version to 3.2 (GH-93337)

   57e8ee7
10. miss-islington

    added a commit that references this issue on Jun 7, 2022

    pythongh-86986: bump min sphinx version to 3.2 (pythonGH-93337)

    afb4419
11. ambv

    added 2 commits that reference this issue on Jun 7, 2022

    gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93561)

    07c3cba

    gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93562)

    6b7b901
12. ambv commented on Jun 7, 2022

    

    ambv

    on Jun 7, 2022

    Contributor

    More actions

    Fixed on 3.10, 3.11, and 3.12.

    Reacted by Adam Turner
13. ambv

    closed this as completedon Jun 7, 2022
14. ambv

    added a commit that references this issue on Jun 21, 2022

    gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)

    0efe3a1
15. miss-islington

    added 4 commits that reference this issue on Jun 21, 2022

    pythongh-86986: Drop compatibility support for Sphinx 2 (pythonGH-9…

    e40f599

    pythongh-86986: Drop compatibility support for Sphinx 2 (pythonGH-9…

    6e1c2d8

    gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)

    cc42716

    gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)

    223fde3
16. serhiy-storchaka

    added a commit that references this issue on Jun 26, 2022

    Revert 30935 defer bpo45162 to 312 (#94285)

    1ffde3e

Issue actions