Add GitHub links for Provider API docs #624
Merged
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
|
Hm, this has a legit broken link! Let's wait to merge this. Good job link checker :) |
Eric-Arellano
changed the title
Eric-Arellano
changed the title
frankharkins
approved these changes
Jan 12, 2024
arnaucasau
approved these changes
Jan 12, 2024
Comment on lines
+175
to
+176
| // Certain files do not map 1:1 between sphinx.ext.viewcode and GitHub. | ||
| // When adding new entries, add a dedicated test case! |
There was a problem hiding this comment.
Good idea adding this comment here 👍
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
I didn't realize that Provider already is using the `viewcode` Sphinx extension for current docs, so we didn't need to make any change to that repository to get GitHub source links working. Note that this required adding a new mechanism to special-case certain files because they don't map 1:1 between GitHub and sphinx.ext.viewcode. Other than that change, this PR was generated automatically by running `npm run gen-api -- -p qiskit-ibm-provider -v 0.7.3 -a https://github.com/Qiskit/qiskit-ibm-provider/actions/runs/7330787504/artifacts/1135354934`.
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.
I didn't realize that Provider already is using the
viewcodeSphinx extension for current docs, so we didn't need to make any change to that repository to get GitHub source links working.Note that this required adding a new mechanism to special-case certain files because they don't map 1:1 between GitHub and sphinx.ext.viewcode.
Other than that change, this PR was generated automatically by running
npm run gen-api -- -p qiskit-ibm-provider -v 0.7.3 -a https://github.com/Qiskit/qiskit-ibm-provider/actions/runs/7330787504/artifacts/1135354934.