Fix Sphinx docs issues with extlinks#1743
Conversation
Eric-Arellano
requested review from
HuangJunye,
jakelishman,
javabster,
kevinhartman and
mtreinish
as code owners
Eric-Arellano
changed the title
| # -- Configuration for extlinks extension ------------------------------------ | ||
| # Refer to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html | ||
| extlinks = { | ||
| "pull_terra": ("https://github.com/Qiskit/qiskit-terra/pull/%s", "#"), |
There was a problem hiding this comment.
I found many release notes refer to terra issues but the links are normal links. See https://qiskit.org/documentation/release_notes.html#bug-fixes
For example #9798 <https://github.com/Qiskit/qiskit-terra/issues/9798> in:
There was a problem hiding this comment.
If we keep others, I think we should keep pull_terra and advertise the usage of this plugin. If not, perhaps we can change where pull_aer and pull_ibmq-provider are used to normal links and get rid of the extlinks altogether.
There was a problem hiding this comment.
Sure, added back.
| "pull_aer": ("https://github.com/Qiskit/qiskit-aer/pull/%s", "qiskit-aer #%s"), | ||
| "pull_ibmq-provider": ( | ||
| "https://github.com/Qiskit/qiskit-ibmq-provider/pull/%s", | ||
| "qiskit-ibmq-provider #%s", | ||
| ), |
There was a problem hiding this comment.
These are used in release_notes.py, like this:
Refactor thread management :pull_aer:`50`
This changes the text that we will render. Before, #50. Now, qiskit-aer #50.
There was a problem hiding this comment.
I didn't know this extension exist. It's quite handy. We should use it more.
Eric-Arellano
changed the title
|
I removed the controversial parts of this PR because I'm going to open a dedicated PR for it. It's bigger surgery. This PR is ready to go and has no controversy. |
…into fix-exceptions-import
* WIP: debug import failure for dagcircuits.exceptions * Revert "WIP: debug import failure for dagcircuits.exceptions" This reverts commit a40a25b6fd23fe24f7ece6fa11e94cca8e7ceaf4. * Try double backticks * Fix issue with extlink * Fix loading of versionutils * Revert maintainers guide change for now * Add Terra back --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
3 participants
We've been getting this error in our docs, which blocks us from enabling
-W(error on warnings):