Change default value of intersphinx_disabled_reftypes #9804
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Incompatible change of default value for
intersphinx_disabled_reftypesto disallowstd:docreferences without an explicit intersphinx inventory to be resolved by intersphinx.Implements step 2 of #9459 (comment), essentially fixing #2068.
Detail
Transparent intersphinx resolution is great in many cases, but for
:doc:and:ref:it can be surprising, hence disabling them by default is preferable. Users can change the configuration variable, or better yet, write an explicit intersphinx inventory name in each reference they intend to go outside the current project.