Skip to content

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 29, 2025
Merged

Docs: Prepare for Sphinx 9 #142057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/howto/urllib2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Introduction
You may also find useful the following article on fetching web resources
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>`__
Copy link
Member

@hugovk hugovk Nov 29, 2025

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.

Copy link
Member

@hugovk hugovk Nov 29, 2025

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


A tutorial on *Basic Authentication*, with examples in Python.

Expand Down
7 changes: 2 additions & 5 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2095,11 +2095,8 @@ to sockets.
Accepts any real number, not only integer or float.


.. method:: socket.setsockopt(level, optname, value: int)
.. method:: socket.setsockopt(level, optname, value: buffer)
:noindex:
.. method:: socket.setsockopt(level, optname, None, optlen: int)
:noindex:
.. method:: socket.setsockopt(level, optname, value: int | Buffer)
socket.setsockopt(level, optname, None, optlen: int)

.. index:: pair: module; struct

Expand Down
2 changes: 1 addition & 1 deletion Doc/tools/extensions/glossary_search.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def process_glossary_nodes(
rendered = app.builder.render_partial(definition)
terms[term.lower()] = {
'title': term,
'body': rendered['html_body'],
'body': rendered['fragment'],
Copy link
Member

@hugovk hugovk Nov 29, 2025

Choose a reason for hiding this comment

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

What does this do?

Copy link
Member Author

@AA-Turner AA-Turner Nov 29, 2025

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

}


Expand Down
Loading