Skip to content

Commit 68abc2a

Browse files
committed
Change default value of intersphinx_disabled_reftypes
See discussion in sphinx-doc#9459
1 parent 4c19d9f commit 68abc2a

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

CHANGES

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Dependencies
77
Incompatible changes
88
--------------------
99

10+
* #2068: :confval:`intersphinx_disabled_reftypes` has changed default value
11+
from an empty list to ``['std:doc']`` as avoid too surprising silent
12+
intersphinx resolutions.
13+
To migrate: either add an explicit inventory name to the references
14+
intersphinx should resolve, or explicitly set the value of this configuration
15+
variable to an empty list.
16+
1017
Deprecated
1118
----------
1219

doc/usage/extensions/intersphinx.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,10 @@ linking:
152152

153153
.. versionadded:: 4.3
154154

155+
.. versionchanged:: 5.0
156+
157+
Changed default value from an empty list to ``['std:doc']``.
158+
155159
A list of strings being either:
156160

157161
- the name of a specific reference type in a domain,
@@ -160,7 +164,7 @@ linking:
160164
``std:*``, ``py:*``, or ``cpp:*``, or
161165
- simply a wildcard ``*``.
162166

163-
The default value is an empty list.
167+
The default value is ``['std:doc']``.
164168

165169
When a cross-reference without an explicit inventory specification is being
166170
resolved by intersphinx, skip resolution if it matches one of the

sphinx/ext/intersphinx.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
494494
app.add_config_value('intersphinx_mapping', {}, True)
495495
app.add_config_value('intersphinx_cache_limit', 5, False)
496496
app.add_config_value('intersphinx_timeout', None, False)
497-
app.add_config_value('intersphinx_disabled_reftypes', [], True)
497+
app.add_config_value('intersphinx_disabled_reftypes', ['std:doc'], True)
498498
app.connect('config-inited', normalize_intersphinx_mapping, priority=800)
499499
app.connect('builder-inited', load_mappings)
500500
app.connect('missing-reference', missing_reference)

0 commit comments

Comments
 (0)