FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

GH-99380: Update to Sphinx 7 by AA-Turner · Pull Request #99381 · python/cpython · GitHub

Repository navigation

GH-99380: Update to Sphinx 7 - #99381

Merged
AA-Turner merged 19 commits into
python:mainfrom
AA-Turner:sphinx-5
Jan 20, 2024
Merged

AA-Turner merged 19 commits into
python:mainfrom
AA-Turner:sphinx-5

Conversation

AA-Turner commented Nov 11, 2022 •
edited by hugovk
Loading

Copy link
Copy Markdown
Member

Copy link
Copy Markdown
Member Author

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

arhadthedev changed the title gh-99380: Update to Sphinx 5.3.0 gh-99380: Update to Sphinx 6.1.3 Apr 21, 2023

CAM-Gerlach commented Apr 26, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Especially if we're going to backport this change to 3.11 (which might also enable the dark theme there), we should add a job to build the docs on the minimum Sphinx version specified in the conf.py, so we can continue to verify everything will build (without warnings) on the minimum version we support redistributors using, as we have for the past. This will allow us to be more flexible with keeping all supported docs versions in sync and up to date with the latest Sphinx changes and improvements.

We also have to consider if we want to retain the now opt-out option for listing functions, classes, etc. in the toctree enabled, since this PR effectively flips that switch. Maybe it should be disabled for now and enabled in a separate PR after appropriate discussion (on Discourse, etc)?

Copy link
Copy Markdown
Member Author

We've spoken about a minimum build for a while -- whilst I don't think it should block this work, I'll open a new PR to that effect (do you think we need a new issue to discuss that?).

I'm biased, as I added the feature, but I think it is a real usability win to have the direct links, and so long as the theme responds reasonably (eg on long names), which I'll test, I think we should keep the defaults as a net benefit (especially in reference-type documentation).

A

Copy link
Copy Markdown
Member Author

Cross-linking #103904 for the oldest-supported testing.

A

Copy link
Copy Markdown
Member Author

AA-Turner changed the title gh-99380: Update to Sphinx 6.1.3 GH-99380: Update to Sphinx 7 May 4, 2023
# Conflicts:
#	Doc/requirements.txt
#	Doc/tools/extensions/pyspecific.py
Comment thread Doc/requirements.txt Outdated
AA-Turner merged commit e649515 into python:main Jan 20, 2024

Copy link
Copy Markdown

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

AA-Turner deleted the sphinx-5 branch January 20, 2024 11:20

Copy link
Copy Markdown

Sorry, @AA-Turner, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker e6495159f6f2ca4fe3b5143c62fc2ad5873ef54f 3.12

Copy link
Copy Markdown

Sorry, @AA-Turner, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker e6495159f6f2ca4fe3b5143c62fc2ad5873ef54f 3.11

bedevere-app Bot commented Jan 20, 2024

Copy link
Copy Markdown

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

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Jan 20, 2024

bedevere-app Bot commented Jan 20, 2024

Copy link
Copy Markdown

GH-114342 is a backport of this pull request to the 3.11 branch.

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Jan 20, 2024
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Jan 20, 2024
(cherry picked from commit e649515)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull request Jan 20, 2024
AA-Turner added a commit that referenced this pull request Jan 20, 2024
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

4 participants


Back | FazBrowse Home | New Git URL