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
base: main
Are you sure you want to change the base?
GH-99380: Update to Sphinx 7 #99381
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
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 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)? |
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 |
Cross-linking #103904 for the oldest-supported testing. A |
To resolve: ToC directives, e.g. https://deploy-preview-99381--python-cpython-preview.netlify.app/library/index.html |
# Conflicts: # Doc/requirements.txt
This reverts commit 7816c8d
# Conflicts: # Doc/requirements.txt # Doc/tools/extensions/pyspecific.py
Preview: https://cpython-previews--99381.org.readthedocs.build/en/99381/