IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

intersphinx role, update docs

Browse Source
This commit is contained in:
Jakob Lykke Andersen 2022-01-15 14:05:42 +01:00
parent c11b109d59
commit 3bf8bcd6e1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/usage/extensions/intersphinx.rst
View File

@ -25,7 +25,7 @@ projects, and optionally to a specific external project.
A link like ``:external:ref:`comparison manual <comparisons>``` will then link A link like ``:external:ref:`comparison manual <comparisons>``` will then link
to the label "comparisons" in whichever configured external project, if it to the label "comparisons" in whichever configured external project, if it
exists, exists,
and a link like ``:external:python+ref:`comparison manual <comparisons>``` will and a link like ``:external+python:ref:`comparison manual <comparisons>``` will
link to the label "comparisons" only in the doc set "python", if it exists. link to the label "comparisons" only in the doc set "python", if it exists.
Behind the scenes, this works as follows: Behind the scenes, this works as follows:
@ -173,7 +173,7 @@ linking:
For example, with ``intersphinx_disabled_reftypes = ['std:doc']`` For example, with ``intersphinx_disabled_reftypes = ['std:doc']``
a cross-reference ``:doc:`installation``` will not be attempted to be a cross-reference ``:doc:`installation``` will not be attempted to be
resolved by intersphinx, but ``:external:otherbook+doc:`installation``` will resolved by intersphinx, but ``:external+otherbook:doc:`installation``` will
be attempted to be resolved in the inventory named ``otherbook`` in be attempted to be resolved in the inventory named ``otherbook`` in
:confval:`intersphinx_mapping`. :confval:`intersphinx_mapping`.
At the same time, all cross-references generated in, e.g., Python, At the same time, all cross-references generated in, e.g., Python,
@ -207,10 +207,10 @@ The Intersphinx extension provides the following role.
then the key of the project, as specified in :confval:`intersphinx_mapping`, then the key of the project, as specified in :confval:`intersphinx_mapping`,
is added as well to get the two forms is added as well to get the two forms
- ``:external:invname+domain:reftype:`target```, - ``:external+invname:domain:reftype:`target```,
e.g., ``:external:python+py:class:`zipfile.ZipFile```, or e.g., ``:external+python:py:class:`zipfile.ZipFile```, or
- ``:external:invname+reftype:`target```, - ``:external+invname:reftype:`target```,
e.g., ``:external:python+doc:`installation```. e.g., ``:external+python:doc:`installation```.
Showing all links of an Intersphinx mapping file Showing all links of an Intersphinx mapping file
------------------------------------------------ ------------------------------------------------