[WIP] intersphinx, allow an inventory to be a self ref#10127
Closed
jakobandersen wants to merge 1 commit into
Closed
[WIP] intersphinx, allow an inventory to be a self ref#10127jakobandersen wants to merge 1 commit into
jakobandersen wants to merge 1 commit into
Conversation
0ce205c to
e172799
Compare
Member
|
I can understand the case. But I feel very strange to annotate "local" reference as an "external" reference... I'm not sure this should be implemented as a built-in feature. |
Contributor
Author
It is indeed a bit of a hax. Ideally the root of the problem, that docstrings are copied from external projects, should be addressed directly. |
1 task
Member
|
Closing in favour of #13291. A |
This file contains hidden or 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.
3 participants
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
Purpose
A resolution for #9169 where a new config variable
intersphinx_self_mappingcan be used to specify an inventory name which will make corresponding:external+thatName:domain:role:references to fall back as if the user wrote:domain:role:.This is useful for Python projects where a docstring can be inherited from an external project. That external project would need to write
:external:references in those docstrings and use this self-mapping mechanism.TODOs:
env_versionbump?Relates
Fixes #9169