Fix some C API objects.inv links
#4304
Merged
+31
−10
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
npm run regen-apis git restore public/**/*.avif --source ad25290
arnaucasau
reviewed
Nov 24, 2025
Collaborator
arnaucasau
left a comment
arnaucasau
left a comment
There was a problem hiding this comment.
Amazing work with this, Frank! I updated the PR description to link to #4200 :)
arnaucasau
approved these changes
Nov 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Part of #4200
Looking at the broken links, the vast majority have a period (
.) in their anchors because they're links to members of an object./docs/api/qiskit-c/qk-bit-term#qk_bitterm_label.bit_term. The part after the period is a parameter of the functionqk_bitterm_label. Parameters don't have HTML anchors, hence the broken link./docs/api/qiskit-c/qk-circuit#qkdelayunit.qkdelayunit_ms, a value ofQkDelayUnit. This enum value does have an anchor, but due to our conversion script, the anchor is#enumerator-qkdelayunit_ms.This PR fixes this by mapping such links to their parent objects. This fixes 220/236 links. While it would be nice to be able to link directly to the members, it's going to be quite a lot of work. Mapping to the parent object is very simple (see 02758e8), and will take the user very close to the memeber.
I regenerated all APIs to make sure this didn't break any other links (it fixed two links in
qiskit-c v2.1). I will continue investigating the other 16 broken links.