-
-
Notifications
You must be signed in to change notification settings - Fork 33.6k
Docs: Prepare for Sphinx 9 #142057
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
Docs: Prepare for Sphinx 9 #142057
Conversation
| terms[term.lower()] = { | ||
| 'title': term, | ||
| 'body': rendered['html_body'], | ||
| 'body': rendered['fragment'], |
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.
What does this do?
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.
body and fragment are aliases. html_body wraps the fragment content in <main> tags, but that's not needed/helpful for this use-case (inserting into the search results).
A
| with Python: | ||
|
|
||
| * `Basic Authentication <https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml>`_ | ||
| * `Basic Authentication <https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml>`__ |
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.
I guess we should generally use anonymous targets as a default, unless we specifically want a named one?
Needing a named one is probably rare.
If so, we could update the examples in the devguide, perhaps with a brief explanation.
And suggest anonymous in reviews.
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.
PR opened: python/devguide#1709
|
Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
(cherry picked from commit 7739943) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
GH-142091 is a backport of this pull request to the 3.14 branch. |
(cherry picked from commit 7739943) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
GH-142092 is a backport of this pull request to the 3.13 branch. |
cc @hugovk @picnixz
Resolves the following:
A
📚 Documentation preview 📚: https://cpython-previews--142057.org.readthedocs.build/