Regenerate addon API docs with reorganization (#2209)

All five addons now use the structure we expect of having a flat list of module pages, along with an index page. Thanks to this PR, we can now run `checkOrphanPages.ts` on the addon projects.
Qiskit · Oct 30, 2024 · f1ae9be · f1ae9be
1 parent 9feacfb
commit f1ae9be
Show file tree

Hide file tree

Showing 164 changed files with 3,567 additions and 3,890 deletions.
diff --git a/docs/api/qiskit-addon-cutting/_toc.json b/docs/api/qiskit-addon-cutting/_toc.json
@@ -7,144 +7,39 @@
     },
     {
       "title": "qiskit_addon_cutting",
-      "children": [
-        {
-          "title": "Module overview",
-          "url": "/api/qiskit-addon-cutting"
-        },
-        {
-          "title": "BaseQPDGate",
-          "url": "/api/qiskit-addon-cutting/qpd-base-qpd-gate"
-        },
-        {
-          "title": "bit_count",
-          "url": "/api/qiskit-addon-cutting/utils-bitwise-bit-count"
-        },
-        {
-          "title": "CommutingObservableGroup",
-          "url": "/api/qiskit-addon-cutting/utils-observable-grouping-commuting-observable-group"
-        },
-        {
-          "title": "ConsolidateResets",
-          "url": "/api/qiskit-addon-cutting/utils-transpiler-passes-consolidate-resets"
-        },
-        {
-          "title": "cut_gates",
-          "url": "/api/qiskit-addon-cutting/cut-gates"
-        },
-        {
-          "title": "cut_wires",
-          "url": "/api/qiskit-addon-cutting/cut-wires"
-        },
-        {
-          "title": "CutWire",
-          "url": "/api/qiskit-addon-cutting/instructions-cut-wire"
-        },
-        {
-          "title": "decompose_qpd_instructions",
-          "url": "/api/qiskit-addon-cutting/qpd-decompose-qpd-instructions"
-        },
-        {
-          "title": "DeviceConstraints",
-          "url": "/api/qiskit-addon-cutting/device-constraints"
-        },
-        {
-          "title": "ExactSampler",
-          "url": "/api/qiskit-addon-cutting/utils-simulation-exact-sampler"
-        },
-        {
-          "title": "expand_observables",
-          "url": "/api/qiskit-addon-cutting/expand-observables"
-        },
-        {
-          "title": "find_cuts",
-          "url": "/api/qiskit-addon-cutting/find-cuts"
-        },
-        {
-          "title": "generate_cutting_experiments",
-          "url": "/api/qiskit-addon-cutting/generate-cutting-experiments"
-        },
-        {
-          "title": "generate_qpd_weights",
-          "url": "/api/qiskit-addon-cutting/qpd-generate-qpd-weights"
-        },
-        {
-          "title": "Move",
-          "url": "/api/qiskit-addon-cutting/instructions-move"
-        },
-        {
-          "title": "ObservableCollection",
-          "url": "/api/qiskit-addon-cutting/utils-observable-grouping-observable-collection"
-        },
-        {
-          "title": "observables_restricted_to_subsystem",
-          "url": "/api/qiskit-addon-cutting/utils-observable-grouping-observables-restricted-to-subsystem"
-        },
-        {
-          "title": "OptimizationParameters",
-          "url": "/api/qiskit-addon-cutting/optimization-parameters"
-        },
-        {
-          "title": "partition_circuit_qubits",
-          "url": "/api/qiskit-addon-cutting/partition-circuit-qubits"
-        },
-        {
-          "title": "partition_problem",
-          "url": "/api/qiskit-addon-cutting/partition-problem"
-        },
-        {
-          "title": "PartitionedCuttingProblem",
-          "url": "/api/qiskit-addon-cutting/partitioned-cutting-problem"
-        },
-        {
-          "title": "QPDBasis",
-          "url": "/api/qiskit-addon-cutting/qpd-qpd-basis"
-        },
-        {
-          "title": "qpdbasis_from_instruction",
-          "url": "/api/qiskit-addon-cutting/qpd-qpdbasis-from-instruction"
-        },
-        {
-          "title": "reconstruct_expectation_values",
-          "url": "/api/qiskit-addon-cutting/reconstruct-expectation-values"
-        },
-        {
-          "title": "RemoveFinalReset",
-          "url": "/api/qiskit-addon-cutting/utils-transpiler-passes-remove-final-reset"
-        },
-        {
-          "title": "separate_circuit",
-          "url": "/api/qiskit-addon-cutting/utils-transforms-separate-circuit"
-        },
-        {
-          "title": "SeparatedCircuits",
-          "url": "/api/qiskit-addon-cutting/utils-transforms-separated-circuits"
-        },
-        {
-          "title": "simulate_statevector_outcomes",
-          "url": "/api/qiskit-addon-cutting/utils-simulation-simulate-statevector-outcomes"
-        },
-        {
-          "title": "SingleQubitQPDGate",
-          "url": "/api/qiskit-addon-cutting/qpd-single-qubit-qpd-gate"
-        },
-        {
-          "title": "TwoQubitQPDGate",
-          "url": "/api/qiskit-addon-cutting/qpd-two-qubit-qpd-gate"
-        },
-        {
-          "title": "unique_by_eq",
-          "url": "/api/qiskit-addon-cutting/utils-iteration-unique-by-eq"
-        },
-        {
-          "title": "unique_by_id",
-          "url": "/api/qiskit-addon-cutting/utils-iteration-unique-by-id"
-        },
-        {
-          "title": "WeightType",
-          "url": "/api/qiskit-addon-cutting/qpd-weight-type"
-        }
-      ]
+      "url": "/api/qiskit-addon-cutting/qiskit-addon-cutting"
+    },
+    {
+      "title": "qiskit_addon_cutting.instructions",
+      "url": "/api/qiskit-addon-cutting/instructions"
+    },
+    {
+      "title": "qiskit_addon_cutting.qpd",
+      "url": "/api/qiskit-addon-cutting/qpd"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.bitwise",
+      "url": "/api/qiskit-addon-cutting/utils-bitwise"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.iteration",
+      "url": "/api/qiskit-addon-cutting/utils-iteration"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.observable_grouping",
+      "url": "/api/qiskit-addon-cutting/utils-observable-grouping"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.simulation",
+      "url": "/api/qiskit-addon-cutting/utils-simulation"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.transforms",
+      "url": "/api/qiskit-addon-cutting/utils-transforms"
+    },
+    {
+      "title": "qiskit_addon_cutting.utils.transpiler_passes",
+      "url": "/api/qiskit-addon-cutting/utils-transpiler-passes"
     },
     {
       "title": "Release notes",

diff --git a/docs/api/qiskit-addon-cutting/cut-gates.mdx b/docs/api/qiskit-addon-cutting/cut-gates.mdx
diff --git a/docs/api/qiskit-addon-cutting/cut-wires.mdx b/docs/api/qiskit-addon-cutting/cut-wires.mdx
diff --git a/docs/api/qiskit-addon-cutting/device-constraints.mdx b/docs/api/qiskit-addon-cutting/device-constraints.mdx
diff --git a/docs/api/qiskit-addon-cutting/expand-observables.mdx b/docs/api/qiskit-addon-cutting/expand-observables.mdx
diff --git a/docs/api/qiskit-addon-cutting/find-cuts.mdx b/docs/api/qiskit-addon-cutting/find-cuts.mdx