GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-117928: Bump the minimum Sphinx version to 6.2.1 by Eclips4 · Pull Request #117853 · python/cpython

Conversation

@Eclips4

@Eclips4 Eclips4 commented Apr 13, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Fixes https://github.com/python/cpython/security/dependabot/6

FYI, I've followed Victor's instructions from this comment.

  • Issue: Increase minimum supported Sphinx to 6.2.1 #117928

📚 Documentation preview 📚: https://cpython-previews--117853.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Eclips4
Regen requirements-oldest-sphinx.txt
e3d2a10
@Eclips4 Eclips4 added skip issue skip news labels Apr 13, 2024
@Eclips4
Eclips4 requested review from AA-Turner, AlexWaygood and hugovk April 13, 2024 16:56
@bedevere-app bedevere-app Bot added the awaiting review label Apr 13, 2024
@nineteendo

nineteendo commented Apr 13, 2024

Copy link
Copy Markdown
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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Eclips4

Eclips4 commented Apr 13, 2024

Copy link
Copy Markdown
Member Author

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?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk

hugovk commented Apr 13, 2024

Copy link
Copy Markdown
Member

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.
Eclips4 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk

hugovk commented Apr 16, 2024

Copy link
Copy Markdown
Member

Survey: #117928
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk

hugovk commented Apr 25, 2024

Copy link
Copy Markdown
Member

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).
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Eclips4

Eclips4 commented Apr 25, 2024

Copy link
Copy Markdown
Member Author

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 ;)
hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Eclips4 Eclips4 changed the title Regen Doc/requirements-oldest-sphinx.txt gh-117928: Bump Sphinx version to 6.2.1 Apr 25, 2024
@Eclips4
First try
aac94ab
@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
@Eclips4
Add a NEWS entry
0ff1abd
@Eclips4 Eclips4 mentioned this pull request Apr 25, 2024
Increase minimum supported Sphinx to 6.2.1 #117928
Closed
@Eclips4 Eclips4 added the needs backport to 3.12 only security fixes label Apr 25, 2024
@hugovk

hugovk commented Apr 25, 2024

Copy link
Copy Markdown
Member

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
Eclips4 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
hugovk
hugovk reviewed Apr 25, 2024
View reviewed changes
Comment thread Doc/conf.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood
AlexWaygood removed their request for review April 25, 2024 19:59
Eclips4 and others added 2 commits April 25, 2024 23:08
@Eclips4 @hugovk
Update comment
eef33e3 
Co-authored-by: Hugo van Kemenade <[email protected]>
@Eclips4
Update workflow
f4318c5
@Eclips4
Eclips4 requested a review from ezio-melotti as a code owner April 25, 2024 20:10
hugovk
hugovk approved these changes Apr 26, 2024
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels Apr 26, 2024
@hugovk
hugovk merged commit 463c20d into python:main Apr 26, 2024
@miss-islington-app

miss-islington-app Bot commented Apr 26, 2024

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label Apr 26, 2024
@miss-islington-app

miss-islington-app Bot commented Apr 26, 2024

Copy link
Copy Markdown

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app miss-islington-app Bot assigned hugovk Apr 26, 2024
@hugovk

hugovk commented Apr 26, 2024

Copy link
Copy Markdown
Member

@Eclips4 Please could you backport?
Eclips4 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Eclips4

Eclips4 commented Apr 26, 2024

Copy link
Copy Markdown
Member Author

@Eclips4 Please could you backport?

Will do it today!
hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Eclips4
Eclips4 deleted the sphinx_oldest branch April 26, 2024 11:04
@bedevere-app

bedevere-app Bot commented Apr 26, 2024

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Apr 26, 2024
hugovk added a commit that referenced this pull request Apr 26, 2024
@Eclips4 @hugovk
[3.12] gh-117928: Bump the minimum Sphinx version to 6.2.1 (GH-117853) (
ef12d23 
#118321)

Co-authored-by: Hugo van Kemenade <[email protected]>
This was referenced Jun 6, 2024
devhelp documentation doesn't build with sphinx 7.2.6 #120150
Closed
sphinx raises an exception when trying to build python 3.13 doc with devhelp sphinx-doc/sphinx#12416
Closed
@AA-Turner AA-Turner mentioned this pull request Jul 18, 2024
GH-117928: Bump the minimum Sphinx version to 6.2.1 #121986
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@hugovk hugovk

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@Eclips4 @nineteendo @hugovk
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.