diff options
| author | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 13:23:23 +0100 |
|---|---|---|
| committer | Jakob Lykke Andersen <Jakob@caput.dk> | 2021-10-31 13:23:23 +0100 |
| commit | cfbac2ceaafc38954c633bd05a6297d8ce89e6e3 (patch) | |
| tree | 790a6e2cc9e9f50263cdb13bfb3e96017300d526 | |
| parent | 9e1ba751ecfa0f5821a7c2f9aff91acb156110d3 (diff) | |
| download | sphinx-git-cfbac2ceaafc38954c633bd05a6297d8ce89e6e3.tar.gz | |
intersphinx_disabled_refs, rename 'all' to '*'
| -rw-r--r-- | doc/usage/extensions/intersphinx.rst | 4 | ||||
| -rw-r--r-- | sphinx/ext/intersphinx.py | 2 | ||||
| -rw-r--r-- | tests/test_ext_intersphinx.py | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/doc/usage/extensions/intersphinx.rst b/doc/usage/extensions/intersphinx.rst index c9075a42d..9063d52ec 100644 --- a/doc/usage/extensions/intersphinx.rst +++ b/doc/usage/extensions/intersphinx.rst @@ -157,7 +157,7 @@ linking: - the name of a specific reference type, 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 ``all``. + - the special name ``*``. When a cross-reference without an explicit inventory specification is being resolved by intersphinx, skip resolution it matches one of the @@ -171,7 +171,7 @@ linking: At the same time, all cross-references generated in, e.g., Python, declarations will still be attempted to be resolved by intersphinx. - If ``all`` is in the list of domains, then no references without an explicit + If ``*`` is in the list of domains, then no references without an explicit inventory will be resolved by intersphinx. diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index 9a41421ea..cab8e77ea 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -363,7 +363,7 @@ def _resolve_reference(env: BuildEnvironment, inv_name: Optional[str], inventory # disabling should only be done if no inventory is given honor_disabled_refs = honor_disabled_refs and inv_name is None - if honor_disabled_refs and 'all' in env.config.intersphinx_disabled_refs: + if honor_disabled_refs and '*' in env.config.intersphinx_disabled_refs: return None typ = node['reftype'] diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index 0ffea0d5f..4d5c08ed6 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -350,7 +350,7 @@ def test_missing_reference_disabled_domain(tempdir, app, status, warning): case(term=False, doc=False, py=True) # disabled all domains - app.config.intersphinx_disabled_refs = ['all'] + app.config.intersphinx_disabled_refs = ['*'] case(term=False, doc=False, py=False) |