Skip to content
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.

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

Reorganize API index page into sections (backport #12333) #12381

Merged
merged 1 commit into from
May 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 66 additions & 19 deletions docs/apidoc/index.rst
Original file line number Diff line number Diff line change
@@ -1,42 +1,89 @@
.. module:: qiskit
..
Within each section, the modules should be ordered alphabetically by
module name (not RST filename).

=============
API Reference
=============

Circuit construction:

.. toctree::
:maxdepth: 1

circuit
circuit_library
circuit_classical
circuit_singleton
compiler
visualization
classicalfunction
circuit_library
circuit_singleton

Quantum information:

.. toctree::
:maxdepth: 1

quantum_info

Transpilation:

.. toctree::
:maxdepth: 1

converters
assembler
dagcircuit
passmanager
synthesis
qiskit.synthesis.unitary.aqc
transpiler
transpiler_passes
transpiler_synthesis_plugins
transpiler_preset
transpiler_plugins

Primitives and providers:

.. toctree::
:maxdepth: 1

primitives
providers
providers_basic_provider
providers_fake_provider
providers_models
pulse
scheduler
synthesis
qiskit.synthesis.unitary.aqc
primitives

Results and visualizations:

.. toctree::
:maxdepth: 1

result
visualization

Serialization:

.. toctree::
:maxdepth: 1

qasm2
qasm3
qobj
qpy
quantum_info
result
transpiler
transpiler_passes
transpiler_preset
transpiler_plugins
transpiler_synthesis_plugins
utils

Pulse-level programming:

.. toctree::
:maxdepth: 1

pulse
scheduler

Other:

.. toctree::
:maxdepth: 1

assembler
compiler
exceptions
qobj
utils
Loading