diff options
author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 15:56:26 +0300 |
---|---|---|
committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 15:56:26 +0300 |
commit | 56002be5e1e5ea712e4e34dc8f4a3b2f446a4be6 (patch) | |
tree | a833bf953db1910035028615b622a741cc3cb782 /doc | |
parent | 484d74ad9773ee61c438c8f176ca16785f3a0614 (diff) |
rename intersphinx_disabled_{refs -> reftypes}
And change format for domains to {name}:*
Diffstat (limited to 'doc')
-rw-r--r-- | doc/usage/extensions/intersphinx.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/usage/extensions/intersphinx.rst b/doc/usage/extensions/intersphinx.rst index 745127971..a3e65bed6 100644 --- a/doc/usage/extensions/intersphinx.rst +++ b/doc/usage/extensions/intersphinx.rst @@ -148,24 +148,25 @@ linking: exception is raised if the server has not issued a response for timeout seconds. -.. confval:: intersphinx_disabled_refs +.. confval:: intersphinx_disabled_reftypes .. versionadded:: 4.3 A list of strings being either: - - the name of a specific reference type, + - the name of a specific reference type in a domain, e.g., ``std:doc``, ``py:func``, or ``cpp:class``, - - the name of a whole domain, e.g., ``std``, ``py``, or ``cpp``, or - - the special name ``*``. + - 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 it matches one of the + resolved by intersphinx, skip resolution if it matches one of the specifications in this list. - For example, with ``intersphinx_disabled_refs = ['std:doc']`` + 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 |