Add tests showing that sphinx.ext.linkcode can be handled
#849
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
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Part of Qiskit#517. Turns out that we already do the right thing! That's because both `sphinx.ext.viewcode` and `sphinx.ext.linkcode` use the same HTML structure. This PR adds tests and better comments to make that clear. The key insight is that we don't need to change the URLs at all, unlike using `sphinx.ext.viewcode`. We assume the source repositories are giving us valid URLs.
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.
Part of #517. Turns out that we already do the right thing! That's because both
sphinx.ext.viewcodeandsphinx.ext.linkcodeuse the same HTML structure.This PR adds tests and better comments to make that clear.
The key insight is that we don't need to change the URLs at all, unlike using
sphinx.ext.viewcode. We assume the source repositories are giving us valid URLs.