[WIP] Preliminary support for the C API in the MDX pipeline #2767
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
fix naming
fix naming
arnaucasau
commented
Mar 12, 2025
Comment on lines
+228
to
+239
| function buildCApiFunction(h: H, node: any) { | ||
| // We use the first child as the signature | ||
| node.properties.signature = toText(node.children[0]).trim(); | ||
| node.children = node.children.splice(1, 1); | ||
|
|
||
| // We use the Function component for C functions | ||
| node.tagName = "function"; | ||
|
|
||
| return buildApiComponent(h, node); | ||
| } | ||
|
|
||
| function buildCApiStruct(h: H, node: any) { |
There was a problem hiding this comment.
I divided it into two functions because I think the implementation of functions and structs will diverge when handling all the edge cases.
| ): void { | ||
| const modulePrefix = "module-"; | ||
| const modulePrefix = isCApi ? "group__" : "module-"; |
There was a problem hiding this comment.
I kept the meta.apiType as module because in my opinion it is strange to have the apiType as group when a single file contains several groups on it. In addition we want the same behavior in the TOC as the python modules
arnaucasau
commented
Mar 12, 2025
| @@ -112,6 +110,7 @@ async function convertFilesToMarkdown( | |||
| imageDestination: pkg.outputDir("/images"), | |||
| releaseNotesTitle: pkg.releaseNotesTitle(), | |||
| hasSeparateReleaseNotes: pkg.hasSeparateReleaseNotes(), | |||
| isCApi: pkg.language == "C", | |||
There was a problem hiding this comment.
This parameter is useful to handle some C API specifics that we don't want for our Python APIs
|
Moving to a draft to explore an alternative to generate functions and structs that it occurred to me and that could make the changes cleaner and easy to maintain. |
arnaucasau
changed the title
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 PR adds support for the Qiskit SDK C API in our MDX pipeline.
For the moment, we are using the python
FunctionandClasscomponents to represent the C functions and structs respectively.I generated the docs by running: