The MDX Pipeline should handle links between the Qiskit Python API and the C API
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- build-system, documentation
Research direction
Start by reviewing the workaround introduced in Qiskit/documentation#3372 and trace how the MDX Pipeline processes the two example links. Compare the Python-to-C and C-to-Python cases, then define a generic fix or an upstream input-HTML improvement; done means both cross-API links are handled sustainably without the workaround.
Written by the indexing model from the issue text.
Description
Our MDX Pipeline was having problems with the links between the Qiskit APIs (Python and C). This is because we are using the same artifact for them both and therefore, the links look like:
Examples:
Link from the Python API to the C API -> cdoc/qk-complex64.html#_CPPv411QkComplex64
Link from the C API to the Python API -> ../stubs/qiskit.circuit.library.UnitaryGate.html#qiskit.circuit.library.UnitaryGate
https://github.com/Qiskit/documentation/pull/3372 introduced a workaround to handle this case, but we should investigate more sustainable fixes like:
- Improve Qiskit/qiskit to handle the links better so that we get valid input HTML, or
- Refactor the code in a more generic way
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Qiskit/documentation
-
content 📄 needs triage 🤔
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Qiskit/documentation#5673 ·
-
content 📄 needs triage 🤔
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Qiskit/documentation#5662 ·
-
content 📄
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Qiskit/documentation#5397 ·
-
content 📄
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Qiskit/documentation#5142 ·
-
ZneOptions typos OpenAPI docs needs triage 🤔
Difficulty 1/5 Under an hour Newbie friendliness 70/100
Qiskit/documentation#5059 · 3 comments ·
All issues in Qiskit/documentation
Similar issues
-
comp/dashboard P3 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#117722 ·
-
Needs Design Priority: Wishlist
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
elementary/flatpak-platform#253 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
objectionary/hone-maven-plugin#1060 ·
-
0.kind: build failure
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Update Vish to 1.1.5 Openpackage-update
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oSoWoSo/vOid_Community_repOsitory#144 · 1 comment ·