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

Increase minimum supported Sphinx to 6.2.1 #117928

Closed
hugovk opened this issue Apr 16, 2024 · 6 comments
Closed

Increase minimum supported Sphinx to 6.2.1 #117928

hugovk opened this issue Apr 16, 2024 · 6 comments
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir

Comments

@hugovk
Copy link
Member

hugovk commented Apr 16, 2024

Documentation

Python 3.11 is now only receiving security updates, so it's time to review the minimum Sphinx version user for 3.12+. We won't change the minimum for the 3.11 branch.

Using the same survey as #109209 (comment):

Distro CPython Sphinx
Debian 12 Bookworm 3.11.2 5.3.0
Debian 13 Trixie (testing) 3.11.6 7.2.6
Debian Sid (unstable) 3.11.8 7.2.6
Debian (experimental) 3.12.1 n/a
Fedora 39 3.12.2 6.2.1
Fedora 40 3.12.2 7.2.6
Fedora rawhide 3.12.3 7.2.6
Gentoo n/a n/a
openSUSE Leap   7.2.6
openSUSE Tumbleweed   7.2.6
RHEL n/a n/a
Minimum Sphinx version for 3.12 3.12 6.2.1

References:

cc:

Linked PRs

@hugovk hugovk added docs Documentation in the Doc dir 3.12 bugs and security fixes 3.13 bugs and security fixes labels Apr 16, 2024
@hroncok
Copy link
Contributor

hroncok commented Apr 16, 2024

cc @befeleme / Fedora / RHEL

@hroncok
Copy link
Contributor

hroncok commented Apr 16, 2024

Fedora: 6.2.1 is good enough for 3.12+

@danigm
Copy link

danigm commented Apr 16, 2024

For openSUSE we're using right now:

  • Sphinx 7.2.6 to build cpython in Tumbleweed
  • Sphinx 4.2.0 to build cpython in Leap

cc @mcepl

@hugovk
Copy link
Member Author

hugovk commented Apr 25, 2024

What Python version do you have in Leap? Is it still 3.6 as a base, and you can install newer versions as additional modules?

When do you plan to upgrade Sphinx in Leap?

Sphinx 4.2.0 is ~3 years old: https://pypi.org/project/Sphinx/4.2.0/

@danigm
Copy link

danigm commented Apr 25, 2024

What Python version do you have in Leap? Is it still 3.6 as a base, and you can install newer versions as additional modules?

When do you plan to upgrade Sphinx in Leap?

Sphinx 4.2.0 is ~3 years old: https://pypi.org/project/Sphinx/4.2.0/

We've also python 3.11 in Leap, right now it's building using sphinx-build provided by Sphinx 4.2.0, using the python 3.6 interpreter, but we've also the 3.11 version, that's 7.2.6. So for future releases we can just use this modern version of Sphinx to build the python interpreter documentation.

So in this specific case, you can forget about the old 4.2.0 version and it should be okay to set the minimum supported Sphinx to 6.2.1. Shouldn't be a problem in openSUSE.

@hugovk
Copy link
Member Author

hugovk commented Apr 25, 2024

Thanks, sounds good, and we'll keep Sphinx 4.2.0 for the 3.11 branch.

hugovk added a commit that referenced this issue Apr 26, 2024
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
hugovk added a commit that referenced this issue Apr 26, 2024
#118321)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@hugovk hugovk closed this as completed Apr 26, 2024
AA-Turner added a commit to AA-Turner/cpython that referenced this issue Jul 18, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 18, 2024
…21986)

(cherry picked from commit 7dd52b6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 18, 2024
…21986)

(cherry picked from commit 7dd52b6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this issue Jul 19, 2024
#121993)

GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986)
(cherry picked from commit 7dd52b6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this issue Jul 19, 2024
#121994)

GH-117928: Bump the minimum Sphinx version to 6.2.1 (GH-121986)
(cherry picked from commit 7dd52b6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants