Skip to content

[WIP] Generate Qiskit 2.2.3 API docs #4159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+6,630 −10,861
Draft

[WIP] Generate Qiskit 2.2.3 API docs #4159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c64c3c7
Generate Python API 2.2.3
arnaucasau Oct 30, 2025
85ea84b
Generate C API 2.2.3
arnaucasau Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/api/qiskit-c/_package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "qiskit-c",
"version": "2.2.1"
"version": "2.2.3"
}
36 changes: 17 additions & 19 deletions docs/api/qiskit-c/qk-bit-term.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,35 +86,33 @@ The numeric structure of these is that they are all four-bit values of which the

## Functions

### qk\_bitterm\_label
**<span id="group__QkBitTerm_1gad8255603d800498cc15ac43da08b11a3" />uint8\_t qk\_bitterm\_label(QkBitTerm bit\_term)**

<Function id="qk_bitterm_label" signature="uint8_t qk_bitterm_label(QkBitTerm bit_term)">
Get the label for a bit term.
Get the label for a bit term.

<span id="group__QkBitTerm_1autotoc_md93" />
<span id="group__QkBitTerm_1autotoc_md93" />

#### Example
### Example

```c
QkBitTerm bit_term = QkBitTerm_Y;
// cast the uint8_t to char
char label = qk_bitterm_label(bit_term);
```
```c
QkBitTerm bit_term = QkBitTerm_Y;
// cast the uint8_t to char
char label = qk_bitterm_label(bit_term);
```

<span id="group__QkBitTerm_1autotoc_md94" />
<span id="group__QkBitTerm_1autotoc_md94" />

#### Safety
### Safety

<span id="group__QkBitTerm_1autotoc_md94" />
<span id="group__QkBitTerm_1autotoc_md94" />

The behavior is undefined if `bit_term` is not a valid `uint8_t` value of a `QkBitTerm`.
The behavior is undefined if `bit_term` is not a valid `uint8_t` value of a `QkBitTerm`.

**Parameters**
**Parameters**

**bit\_term** – The bit term.
* **bit\_term** – The bit term.

**Returns**
**Returns**

The label as `uint8_t`, which can be cast to `char` to obtain the character.
</Function>
The label as `uint8_t`, which can be cast to `char` to obtain the character.

Loading
Loading