Skip to content

Commit cfbac2c

Browse files
committed
intersphinx_disabled_refs, rename 'all' to '*'
1 parent 9e1ba75 commit cfbac2c

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

doc/usage/extensions/intersphinx.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ linking:
157157
- the name of a specific reference type,
158158
e.g., ``std:doc``, ``py:func``, or ``cpp:class``,
159159
- the name of a whole domain, e.g., ``std``, ``py``, or ``cpp``, or
160-
- the special name ``all``.
160+
- the special name ``*``.
161161

162162
When a cross-reference without an explicit inventory specification is being
163163
resolved by intersphinx, skip resolution it matches one of the
@@ -171,7 +171,7 @@ linking:
171171
At the same time, all cross-references generated in, e.g., Python,
172172
declarations will still be attempted to be resolved by intersphinx.
173173

174-
If ``all`` is in the list of domains, then no references without an explicit
174+
If ``*`` is in the list of domains, then no references without an explicit
175175
inventory will be resolved by intersphinx.
176176

177177

sphinx/ext/intersphinx.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ def _resolve_reference(env: BuildEnvironment, inv_name: Optional[str], inventory
363363
# disabling should only be done if no inventory is given
364364
honor_disabled_refs = honor_disabled_refs and inv_name is None
365365

366-
if honor_disabled_refs and 'all' in env.config.intersphinx_disabled_refs:
366+
if honor_disabled_refs and '*' in env.config.intersphinx_disabled_refs:
367367
return None
368368

369369
typ = node['reftype']

tests/test_ext_intersphinx.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ def assert_(rn, expected):
350350
case(term=False, doc=False, py=True)
351351

352352
# disabled all domains
353-
app.config.intersphinx_disabled_refs = ['all']
353+
app.config.intersphinx_disabled_refs = ['*']
354354
case(term=False, doc=False, py=False)
355355

356356

0 commit comments

Comments
 (0)