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

gh-117928: Bump the minimum Sphinx version to 6.2.1 #117853

Merged
merged 5 commits into from Apr 26, 2024

Conversation

Eclips4
Copy link
Member

@Eclips4 Eclips4 commented Apr 13, 2024

@nineteendo
Copy link
Contributor

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

@Eclips4
Copy link
Member Author

Eclips4 commented Apr 13, 2024

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

Thanks for pointing this out.
@hugovk @AA-Turner Maybe it's time to switch to Sphinx 5.0?

@hugovk
Copy link
Member

hugovk commented Apr 13, 2024

Now that the 3.11 branch is only accepting security fixes, for 3.12+ I think we can bump the oldest supported Sphinx to at least 6.2.1.

Let's open a new issue to do a similar survey to #109209.

@hugovk
Copy link
Member

hugovk commented Apr 16, 2024

Survey: #117928

@hugovk
Copy link
Member

hugovk commented Apr 25, 2024

OK, according to #117928 we can upgrade to Sphinx 6.2.1 as the minimum for the 3.12 and main branches.

Would you like to update this PR? We can also use that issue number for this PR.

There's some compatibility code for old Sphinx we can remove from some files Doc/tools, and let's also rename master_doc in conf.py to root_doc (ref).

@Eclips4
Copy link
Member Author

Eclips4 commented Apr 25, 2024

OK, according to #117928 we can upgrade to Sphinx 6.2.1 as the minimum for the 3.12 and main branches.

Would you like to update this PR? We can also use that issue number for this PR.

There's some compatibility code for old Sphinx we can remove from some files Doc/tools, and let's also rename master_doc in conf.py to root_doc (ref).

I'll update this PR as soon as possible ;)

@Eclips4 Eclips4 changed the title Regen Doc/requirements-oldest-sphinx.txt gh-117928: Bump Sphinx version to 6.2.1 Apr 25, 2024
@Eclips4 Eclips4 changed the title gh-117928: Bump Sphinx version to 6.2.1 gh-117928: Bump the minimum Sphinx version to 6.2.1 Apr 25, 2024
@hugovk
Copy link
Member

hugovk commented Apr 25, 2024

Thanks, let's also try using 3.12 in .github/workflows/reusable-docs.yml and put 6.2.1 in the comment:

        python-version: '3.11'  # known to work with Sphinx 4.2

Doc/conf.py Outdated Show resolved Hide resolved
@AlexWaygood AlexWaygood removed their request for review April 25, 2024 19:59
Eclips4 and others added 2 commits April 25, 2024 23:08
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@hugovk hugovk merged commit 463c20d into python:main Apr 26, 2024
35 checks passed
@miss-islington-app
Copy link

Thanks @Eclips4 for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @Eclips4 and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 463c20dae9ac91d6c44028177b90f43238b819cf 3.12

@hugovk
Copy link
Member

hugovk commented Apr 26, 2024

@Eclips4 Please could you backport?

@Eclips4
Copy link
Member Author

Eclips4 commented Apr 26, 2024

@Eclips4 Please could you backport?

Will do it today!

@Eclips4 Eclips4 deleted the sphinx_oldest branch April 26, 2024 11:04
@bedevere-app
Copy link

bedevere-app bot commented Apr 26, 2024

GH-118321 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Apr 26, 2024
hugovk added a commit that referenced this pull request Apr 26, 2024
#118321)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants