diff options
| author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 14:44:45 +0100 |
|---|---|---|
| committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 14:44:45 +0100 |
| commit | 4c19d9f65a261ff5d378563110fa2af7c2d64752 (patch) | |
| tree | 3a6e936c05ffe948c3742b1d8bc97d5c3d1238a6 /doc/usage/extensions | |
| parent | b32d4b500a5d92b3c5cbbecbdc1a2ce4186b5b6d (diff) | |
| parent | a8eb1aab72a514b7257c780c0c57432732a702fb (diff) | |
| download | sphinx-git-4c19d9f65a261ff5d378563110fa2af7c2d64752.tar.gz | |
Merge branch '4.x'
Diffstat (limited to 'doc/usage/extensions')
| -rw-r--r-- | doc/usage/extensions/intersphinx.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/usage/extensions/intersphinx.rst b/doc/usage/extensions/intersphinx.rst index 478ddb7ae..a3e65bed6 100644 --- a/doc/usage/extensions/intersphinx.rst +++ b/doc/usage/extensions/intersphinx.rst @@ -148,6 +148,35 @@ linking: exception is raised if the server has not issued a response for timeout seconds. +.. confval:: intersphinx_disabled_reftypes + + .. versionadded:: 4.3 + + A list of strings being either: + + - the name of a specific reference type in a domain, + e.g., ``std:doc``, ``py:func``, or ``cpp:class``, + - the name of a domain, and a wildcard, e.g., + ``std:*``, ``py:*``, or ``cpp:*``, or + - simply a wildcard ``*``. + + The default value is an empty list. + + When a cross-reference without an explicit inventory specification is being + resolved by intersphinx, skip resolution if it matches one of the + specifications in this list. + + For example, with ``intersphinx_disabled_reftypes = ['std:doc']`` + a cross-reference ``:doc:`installation``` will not be attempted to be + resolved by intersphinx, but ``:doc:`otherbook:installation``` will be + attempted to be resolved in the inventory named ``otherbook`` in + :confval:`intersphinx_mapping`. + At the same time, all cross-references generated in, e.g., Python, + declarations will still be attempted to be resolved by intersphinx. + + If ``*`` is in the list of domains, then no references without an explicit + inventory will be resolved by intersphinx. + Showing all links of an Intersphinx mapping file ------------------------------------------------ |
