config: Add 'link_inline_targets' #10194
Closed
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
In 4.4.0, we started allowing users to reference an inline target via the 'ref' role. This had the unfortunate side-effect of changing inline targets from locally scoped to globally scoped, breaking many document trees in the process. Add a new config option, 'link_inline_targets', which will allow users to opt-in to this behavior if they wish to use it. It is disabled by default. Signed-off-by: Stephen Finucane <stephen@that.guru>
This was referenced Feb 14, 2022
|
#10178 is an alternative that removes this feature entirely rather than making it configurable. |
|
I determined to revert #9993 during 4.x and reconsider to merge it again on 5.0 release (including this option). |
|
Feature was reverted--@stephenfin if you would like to keep this PR please re-open it. A |
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.
Feature or Bugfix
(it's a bit of both)
Purpose
In Sphinx 4.4.0 as result of #9993, we have lost the ability to use reference-style links in docs except where the references are unique. For example, you can no longer use
[1]style links. This is a breaking change for many users and should not have been included in a MINOR release.This PR adds a new configuration option,
link_inline_targets, to disable this behavior by default.Closes #10177
Detail
link_inline_targetsconfig optionRelates