Skip to content

Test API generation with a Sphinx 9.1.0 artifact #4605

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
arnaucasau wants to merge 3 commits into
base: main
Choose a base branch
from
+1,030 −902
Draft

Test API generation with a Sphinx 9.1.0 artifact #4605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3edca43
Sync latest dev docs
github-actions[bot] Jan 28, 2026
d14acd6
Workaround Sphinx 9
arnaucasau Jan 29, 2026
0742f01
Generate dev version from artifact
arnaucasau Jan 29, 2026
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
  •  
  •  
  •  
10 changes: 5 additions & 5 deletions docs/api/qiskit/dev/circuit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.circuit
---

<span id="quantum-circuit-model-qiskit-circuit" />

<span id="module-qiskit.circuit" />

<span id="qiskit-circuit" />

<span id="quantum-circuit-model-qiskit-circuit" />

# Quantum circuit model

`qiskit.circuit`
Expand Down Expand Up @@ -418,8 +418,8 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera

**Parameters**

* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) –
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) –
* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int))
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*)
</Class>

#### PowerModifier
Expand All @@ -431,7 +431,7 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera

**Parameters**

**power** ([*float*](https://docs.python.org/3/library/functions.html#float)) –
**power** ([*float*](https://docs.python.org/3/library/functions.html#float))
</Class>

For information on how to create custom gates and instructions, including how to build one-off objects, and re-usable parametric gates via subclassing, see [Creating custom instructions](#circuit-custom-gates) below. The Qiskit circuit library in [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") contains many predefined gates and circuits for you to use.
Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit/dev/circuit_annotation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.circuit.annotation
---

<span id="circuit-annotations-qiskit-circuit-annotation" />

<span id="module-qiskit.circuit.annotation" />

<span id="qiskit-circuit-annotation" />

<span id="circuit-annotations-qiskit-circuit-annotation" />

# Circuit annotations

`qiskit.circuit.annotation`
Expand Down Expand Up @@ -56,7 +56,7 @@ A stand-alone function allows iterating through namespaces and parent namespaces

**Parameters**

**namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) –
**namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str))

**Return type**

Expand Down
160 changes: 80 additions & 80 deletions docs/api/qiskit/dev/circuit_classical.mdx
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/api/qiskit/dev/circuit_library.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.circuit.library
---

<span id="circuit-library-qiskit-circuit-library" />

<span id="module-qiskit.circuit.library" />

<span id="qiskit-circuit-library" />

<span id="circuit-library-qiskit-circuit-library" />

# Circuit Library

`qiskit.circuit.library`
Expand Down Expand Up @@ -2154,7 +2154,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

#### rzx\_xz
Expand All @@ -2177,7 +2177,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

#### rzx\_cy
Expand All @@ -2195,7 +2195,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

#### rzx\_zz1
Expand Down Expand Up @@ -2223,7 +2223,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

#### rzx\_zz2
Expand All @@ -2246,7 +2246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

#### rzx\_zz3
Expand All @@ -2269,6 +2269,6 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui

**Parameters**

**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) –
**theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*)
</Function>

4 changes: 2 additions & 2 deletions docs/api/qiskit/dev/circuit_random.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ python_api_type: module
python_api_name: qiskit.circuit.random
---

<span id="module-qiskit.circuit.random" />

<span id="random-circuits-qiskit-circuit-random" />

<span id="module-qiskit.circuit.random" />

# Random Circuits

`qiskit.circuit.random`
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/dev/circuit_singleton.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.circuit.singleton
---

<span id="singleton-instructions-qiskit-circuit-singleton" />

<span id="module-qiskit.circuit.singleton" />

<span id="qiskit-circuit-singleton" />

<span id="singleton-instructions-qiskit-circuit-singleton" />

# Singleton instructions

`qiskit.circuit.singleton`
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/dev/compiler.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.compiler
---

<span id="compilation-routines-qiskit-compiler" />

<span id="module-qiskit.compiler" />

<span id="qiskit-compiler" />

<span id="compilation-routines-qiskit-compiler" />

# Compilation Routines

`qiskit.compiler`
Expand Down
4 changes: 2 additions & 2 deletions docs/api/qiskit/dev/converters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.converters
---

<span id="circuit-converters-qiskit-converters" />

<span id="module-qiskit.converters" />

<span id="qiskit-converters" />

<span id="circuit-converters-qiskit-converters" />

# Circuit Converters

`qiskit.converters`
Expand Down
22 changes: 11 additions & 11 deletions docs/api/qiskit/dev/dagcircuit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@ python_api_type: module
python_api_name: qiskit.dagcircuit
---

<span id="dag-circuits-qiskit-dagcircuit" />

<span id="module-qiskit.dagcircuit" />

<span id="qiskit-dagcircuit" />

<span id="dag-circuits-qiskit-dagcircuit" />

# DAG Circuits

`qiskit.dagcircuit`

## Circuits as Directed Acyclic Graphs

| | |
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. |
| [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[nid]) | Parent class for DAGOpNode, DAGInNode, and DAGOutNode. |
| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs]) | Object to represent an Instruction at a node in the DAGCircuit. |
| [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")(wire) | Object to represent an incoming wire node in the DAGCircuit. |
| [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")(wire) | Object to represent an outgoing wire node in the DAGCircuit. |
| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). |
| [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. |
| | |
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. |
| [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[nid]) | Parent class for DAGOpNode, DAGInNode, and DAGOutNode. |
| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs]) | Object to represent an Instruction at a node in the DAGCircuit. |
| [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")(wire) | Object to represent an incoming wire node in the DAGCircuit. |
| [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")(wire) | Object to represent an outgoing wire node in the DAGCircuit. |
| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). |
| [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). |

## Exceptions

Expand Down
12 changes: 6 additions & 6 deletions docs/api/qiskit/dev/exceptions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.exceptions
---

<span id="top-level-exceptions-qiskit-exceptions" />

<span id="module-qiskit.exceptions" />

<span id="qiskit-exceptions" />

<span id="top-level-exceptions-qiskit-exceptions" />

# Top-level exceptions

`qiskit.exceptions`
Expand Down Expand Up @@ -49,10 +49,10 @@ Qiskit has several optional features that depend on other packages that are not

**Parameters**

* **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) –
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) –
* **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) –
* **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) –
* **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str))
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str))
* **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*)
* **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*)

**Return type**

Expand Down
1 change: 1 addition & 0 deletions docs/api/qiskit/dev/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,6 @@ Other:

* [Compilation Routines (`qiskit.compiler`)](compiler)
* [Top-level exceptions (`qiskit.exceptions`)](exceptions)
* [Root namespace (`qiskit`)](root)
* [Utilities (`qiskit.utils`)](utils)

4 changes: 2 additions & 2 deletions docs/api/qiskit/dev/passmanager.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ python_api_type: module
python_api_name: qiskit.passmanager
---

<span id="passmanager-qiskit-passmanager" />

<span id="module-qiskit.passmanager" />

<span id="qiskit-passmanager" />

<span id="passmanager-qiskit-passmanager" />

# Passmanager

`qiskit.passmanager`
Expand Down
Loading
Loading