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-99380: Update to Sphinx 7 #99381

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

GH-99380: Update to Sphinx 7 #99381

wants to merge 18 commits into from

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Nov 11, 2022

@AA-Turner
Copy link
Member Author

@AA-Turner AA-Turner added needs backport to 3.10 only security fixes needs backport to 3.11 bug and security fixes labels Nov 11, 2022
@hugovk

This comment was marked as resolved.

@AA-Turner

This comment was marked as resolved.

@AA-Turner

This comment was marked as resolved.

@arhadthedev 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
Copy link
Member

CAM-Gerlach commented Apr 26, 2023

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)?

@AA-Turner
Copy link
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

@AA-Turner
Copy link
Member Author

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

A

@AA-Turner
Copy link
Member Author

@AA-Turner AA-Turner changed the title gh-99380: Update to Sphinx 6.1.3 GH-99380: Update to Sphinx 7 May 4, 2023
@hugovk hugovk added the needs backport to 3.12 bug and security fixes label Aug 4, 2023
# Conflicts:
#	Doc/requirements.txt
#	Doc/tools/extensions/pyspecific.py
Doc/requirements.txt Outdated Show resolved Hide resolved
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

4 participants