qiskit/docs/apidoc
Jake Lishman 72ad545a87
Write complete manual `QuantumCircuit` documentation (#12403)
* Write complete manual `QuantumCircuit` documentation

This writes huge tracts of new `QuantumCircuit` API documentation,
linking together alike methods and writing explanatory text for how all
the components fit together.  There's likely an awful lot more that
could go into this too, but this hopefully should impose a lot more
order on the huge `QuantumCircuit` documentation page, and provide a lot
more explanation for how the class works holistically.

In particular, the section on the control-flow builder interface could
do with a lot more exposition and examples right now.

* Reword from review

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

* Add missing text around `Var` methods

* Add example to `find_bit`

* Comment on metadata through serialization

* Add see-also sections to undesirable methods

* Re-add internal utilities to documentation

* Add examples to `depth`

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
2024-05-16 13:40:46 +00:00
..
assembler.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
circuit.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
circuit_classical.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
circuit_library.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
circuit_singleton.rst Rewrite singleton handling including `SingletonInstruction` (#11014) 2023-10-13 19:04:48 +00:00
classicalfunction.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
compiler.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
converters.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
dagcircuit.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
exceptions.rst Add exceptions to API documentation (#10522) 2023-08-14 21:14:41 +00:00
index.rst Write complete manual `QuantumCircuit` documentation (#12403) 2024-05-16 13:40:46 +00:00
passmanager.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
primitives.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
providers.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
providers_basic_provider.rst Rename `BasicAer` to `BasicProvider` and refactor interface to follow `BackendV2` (#11422) 2024-01-30 22:53:27 +00:00
providers_fake_provider.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
providers_models.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
pulse.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
qasm2.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
qasm3.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
qiskit.circuit.QuantumCircuit.rst Write complete manual `QuantumCircuit` documentation (#12403) 2024-05-16 13:40:46 +00:00
qiskit.synthesis.unitary.aqc.rst Link to `qiskit.synthesis.unitary.aqc` on API index page (#12331) 2024-05-05 15:23:31 +00:00
qobj.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
qpy.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
quantum_info.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
result.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
scheduler.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
synthesis.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
transpiler.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
transpiler_passes.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
transpiler_plugins.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
transpiler_preset.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
transpiler_synthesis_plugins.rst add synthesis plugin docs (#11763) 2024-02-15 11:55:15 +00:00
utils.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00
visualization.rst Merge documentation and benchmarks from metapackage 2023-08-11 19:47:50 +01:00