Skip to content

Commit

Permalink
Reorganize API index page into sections
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Arellano committed May 2, 2024
1 parent 0ea3e40 commit c426e82
Showing 1 changed file with 61 additions and 17 deletions.
78 changes: 61 additions & 17 deletions docs/apidoc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,83 @@
API Reference
=============

Circuit construction:

.. toctree::
:maxdepth: 1

circuit
circuit_library
circuit_classical
circuit_singleton
compiler
visualization
classicalfunction

Quantum information:

.. toctree::
:maxdepth: 1

quantum_info

Transpilation:

.. toctree::
:maxdepth: 1

converters
assembler
dagcircuit
passmanager
providers
providers_basic_provider
providers_fake_provider
providers_models
pulse
scheduler
synthesis
qiskit.synthesis.unitary.aqc
primitives
qasm2
qasm3
qobj
qpy
quantum_info
result
transpiler
transpiler_passes
transpiler_preset
transpiler_plugins
transpiler_synthesis_plugins
utils

Primitives and providers:

.. toctree::
:maxdepth: 1

primitives
providers
providers_basic_provider
providers_fake_provider
providers_models

Results and visualizations:

.. toctree::
:maxdepth: 1

result
visualization

Serialization:

.. toctree::
:maxdepth: 1

qasm2
qasm3
qpy

Pulse-level programming:

.. toctree::
:maxdepth: 1

pulse
scheduler

Other:

.. toctree::
:maxdepth: 1

assembler
compiler
exceptions
qobj
utils

0 comments on commit c426e82

Please sign in to comment.