[RFC] Fix multi repo external references #530
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
|
This proposes a fix for an issue first discussed here: sphinx-doc/sphinx#7634 |
utzig
force-pushed
the
fix-inter-repo-xrefs
branch
from
970710f
to
6d07b6d
Compare
When multi-repos are used, the resulting pending_xref's generated from including the source code don't get a 'refdoc' property and the intersphinx 'missing-resolver' is unable to adjust relative paths in a way that links between different projects work. This fixes the issue by adding a transform that fixes pending_xrefs that match some pre-requisites, create a new copy with the 'refdoc' property added and let intersphinx's missing-resolver fix the URI. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
|
Please see my comment in the Sphinx issue. I'm rather sure that Breathe is not at fault in this case. |
|
It seems this one is a bit stuck on both Breathe's and Sphinx's sides, is there anything we can do to get things moving again? |
I will rework this one after other higher priority fixes are implemented, so to avoid it staying stuck here I am closing it (also this is probably not a correct solution anyway!) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When multi-repos are used, the resulting pending_xref's generated from including the source code don't get a 'refdoc' property and the intersphinx 'missing-resolver' is unable to adjust relative paths in a way that links between different projects work.
This fixes the issue by adding a transform that fixes pending_xrefs that match some pre-requisites, create a new copy with the 'refdoc' property added and let intersphinx's missing-resolver fix the URI.