Skip to content

Commit 3bf8bcd

Browse files
committed
intersphinx role, update docs
1 parent c11b109 commit 3bf8bcd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/usage/extensions/intersphinx.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ projects, and optionally to a specific external project.
2525
A link like ``:external:ref:`comparison manual <comparisons>``` will then link
2626
to the label "comparisons" in whichever configured external project, if it
2727
exists,
28-
and a link like ``:external:python+ref:`comparison manual <comparisons>``` will
28+
and a link like ``:external+python:ref:`comparison manual <comparisons>``` will
2929
link to the label "comparisons" only in the doc set "python", if it exists.
3030

3131
Behind the scenes, this works as follows:
@@ -173,7 +173,7 @@ linking:
173173

174174
For example, with ``intersphinx_disabled_reftypes = ['std:doc']``
175175
a cross-reference ``:doc:`installation``` will not be attempted to be
176-
resolved by intersphinx, but ``:external:otherbook+doc:`installation``` will
176+
resolved by intersphinx, but ``:external+otherbook:doc:`installation``` will
177177
be attempted to be resolved in the inventory named ``otherbook`` in
178178
:confval:`intersphinx_mapping`.
179179
At the same time, all cross-references generated in, e.g., Python,
@@ -207,10 +207,10 @@ The Intersphinx extension provides the following role.
207207
then the key of the project, as specified in :confval:`intersphinx_mapping`,
208208
is added as well to get the two forms
209209

210-
- ``:external:invname+domain:reftype:`target```,
211-
e.g., ``:external:python+py:class:`zipfile.ZipFile```, or
212-
- ``:external:invname+reftype:`target```,
213-
e.g., ``:external:python+doc:`installation```.
210+
- ``:external+invname:domain:reftype:`target```,
211+
e.g., ``:external+python:py:class:`zipfile.ZipFile```, or
212+
- ``:external+invname:reftype:`target```,
213+
e.g., ``:external+python:doc:`installation```.
214214

215215
Showing all links of an Intersphinx mapping file
216216
------------------------------------------------

0 commit comments

Comments
 (0)