Skip to content

Infra: Document where to find available intersphinx mappings #5060

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
BHUVANSH855 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

Infra: Document where to find available intersphinx mappings #5060

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
5 changes: 4 additions & 1 deletion peps/pep-0012.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,11 +660,14 @@ You can use
`Intersphinx references
<https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
to other Sphinx sites,
such as the `Python documentation <https://docs.python.org/>`_
such as the `Python documentation <https://docs.python.org/>`_,
`packaging.python.org <https://packaging.python.org/>`_,
and `typing.python.org <https://typing.python.org/>`_,
to easily cross-reference pages, sections and Python/C objects.

The available intersphinx mappings are defined in ``peps/conf.py``.
Refer to that file for the current list of supported mappings.

For example,
to create a link pointing to a section of the typing docs,
you would write the following::
Expand Down
Loading