Basic C API docs #34
Merged
Basic C API docs #34
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
File dependency is not specified elsewhere in this Makefile. Let's refrain from doing that for the C targets, too, as it is not 100% accurately picking up on changes to the Rust source.
|
I have not yet figured out how to get a ToC for the C API page. This seems to be due to some specific configuration of Sphinx within Qiskit, because we can see it working fine on breathe's example pages: https://breathe.readthedocs.io/en/stable/doxygen.html EDIT: nevermind the above. That page's ToC is based on the headings in between the code docs. Another example shows that this does NOT appear to work ootb: https://breathe.readthedocs.io/en/stable/tinyxml.html |
Cryoris
approved these changes
Dec 20, 2024
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.
This starts to set up some basic C API docs.
This is by no means complete but it proposes a potential structure for exposing the C API docs alongside the Python ones.