Add intersphinx configuration for core Qiskit components #622
Conversation
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
This makes it possible to link to documentation in the core Qiskit components (Terra, Aer and IBMQ Provider) using regular Sphinx references.
chriseclectic
approved these changes
Jan 27, 2022
nkanazawa1989
pushed a commit
to nkanazawa1989/qiskit-experiments
that referenced
this pull request
Mar 28, 2022
…unity#622) This makes it possible to link to documentation in the core Qiskit components (Terra, Aer and IBMQ Provider) using regular Sphinx references.
paco-ri
pushed a commit
to paco-ri/qiskit-experiments
that referenced
this pull request
Jul 11, 2022
…unity#622) This makes it possible to link to documentation in the core Qiskit components (Terra, Aer and IBMQ Provider) using regular Sphinx references.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This makes it possible to link to documentation in the core Qiskit
components (Terra, Aer and IBMQ Provider) using regular Sphinx
references.
Details and comments
Stemming from a comment in a review where Chris asked about linking to core Qiskit documentation.
I'm not sure why, but it seems like Sphinx won't search in Intersphinx' inventories if you use the shorthand
:class:`.QuantumVolume`lookup (perhaps for speed concerns), but fully qualified access (in terms of the names objects have in Sphinx) should work fine.