Skip to content

gh-117539: Link to the Python typing spec in typing docs #117540

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

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

gh-117539: Link to the Python typing spec in typing docs #117540

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ac2386
gh-117539: Link to the Python typing spec in typing docs
JelleZijlstra Apr 4, 2024
55df19b
not the default role
JelleZijlstra Apr 4, 2024
a252b68
Merge branch 'main' into intertype
hugovk Apr 10, 2025
1f90c87
Update Doc/conf.py
JelleZijlstra Apr 10, 2025
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
7 changes: 7 additions & 0 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
'pyspecific',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
]

# Skip if downstream redistributors haven't installed them
Expand Down Expand Up @@ -55,6 +56,12 @@

manpages_url = 'https://manpages.debian.org/{path}'

# Intersphinx configuration
intersphinx_mapping = {
'typing': ('https://typing.readthedocs.io/en/latest/', None),
}
intersphinx_disabled_reftypes = []

# General substitutions.
project = 'Python'
copyright = f"2001-{time.strftime('%Y')}, Python Software Foundation"
Expand Down
10 changes: 5 additions & 5 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1494,7 +1494,8 @@ These can be used as types in annotations. They all support subscription using
# and `year` of type `int`.
def foo(**kwargs: Unpack[Movie]): ...

See :pep:`692` for more details on using ``Unpack`` for ``**kwargs`` typing.
See :ref:`the typing spec <typing:unpack-kwargs>` for more details on using
``Unpack`` for ``**kwargs`` typing.

.. versionadded:: 3.11

Expand Down Expand Up @@ -1610,7 +1611,7 @@ without the dedicated syntax, as documented below.
Manually created type variables may be explicitly marked covariant or contravariant by passing
``covariant=True`` or ``contravariant=True``.
By default, manually created type variables are invariant.
See :pep:`484` and :pep:`695` for more details.
See :ref:`the typing spec <typing:variance>` for more details.

Bound type variables and constrained type variables have different
semantics in several important ways. Using a *bound* type variable means
Expand Down Expand Up @@ -1802,7 +1803,7 @@ without the dedicated syntax, as documented below.
to ``call_soon`` match the types of the (positional) arguments of
``callback``.

See :pep:`646` for more details on type variable tuples.
See :ref:`the typing spec <typing:typevartuple>` for more details on type variable tuples.

.. attribute:: __name__

Expand Down Expand Up @@ -1902,8 +1903,7 @@ without the dedicated syntax, as documented below.
be pickled.

.. seealso::
* :pep:`612` -- Parameter Specification Variables (the PEP which introduced
``ParamSpec`` and ``Concatenate``)
* :ref:`typing:paramspec` -- typing specification for ``ParamSpec``
* :data:`Concatenate`
* :ref:`annotating-callables`

Expand Down