Fix metadata detection of modules for historical Qiskit docs (Qiskit#821

) Part of Qiskit#66. We were failing to detect modules using old versions of Sphinx that set the module metadata in `<div>` rather than `<span>` or `<section>`. Some of the module pages had no metadata at all, whereas some were misclassified as `functions` corresponding to the first function in the module's page. Fixing this metadata will fix the HTML meta properties, and it also fixes the table of contents to have correct nesting.
frankharkins · Feb 15, 2024 · e6e482b · e6e482b
1 parent 73d9c5d
commit e6e482b
Show file tree

Hide file tree

Showing 644 changed files with 24,924 additions and 19,632 deletions.
diff --git a/docs/api/qiskit/0.19/_toc.json b/docs/api/qiskit/0.19/_toc.json
diff --git a/docs/api/qiskit/0.19/circuit_library.md b/docs/api/qiskit/0.19/circuit_library.md
@@ -1,8 +1,20 @@
+---
+title: library
+description: API reference for qiskit.circuit.library
+in_page_toc_min_heading_level: 1
+python_api_type: module
+python_api_name: qiskit.circuit.library
+---
+
 <span id="qiskit-circuit-library" />
 
 # Circuit Library
 
-## Circuit Library ([`qiskit.circuit.library`](#module-qiskit.circuit.library "qiskit.circuit.library"))
+## Circuit Library
+
+<span id="module-qiskit.circuit.library" />
+
+`qiskit.circuit.library`
 
 ### Standard Gates
 
@@ -125,3 +137,4 @@
 | [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, …]) | The Pauli Expansion circuit.               |
 | [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, …])             | The first order Pauli Z-evolution circuit. |
 | [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, …])          | Second-order Pauli-Z evolution circuit.    |
+
diff --git a/docs/api/qiskit/0.19/pulse.md b/docs/api/qiskit/0.19/pulse.md
@@ -32,15 +32,15 @@ This is sufficient to allow the quantum physicist to explore and correct for noi
 
 `instructions`
 
-|                                                                                                          |                                                                                                                                                                                                    |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse.                                                                                                    |
-| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration\[, channel, mem\_slot, …])             | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g.                                                                                                        |
-| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration\[, channel, name])                           | A blocking instruction with no other effect.                                                                                                                                                       |
-| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name])                                 | This instruction is responsible for applying a pulse on a channel.                                                                                                                                 |
-| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name])     | Set the channel frequency.                                                                                                                                                                         |
-| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase\[, channel, name])               | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). |
-| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name])              | An instruction targeted for simulators, to capture a moment in the simulation.                                                                                                                     |
+|                                                                                                          |                                                                                                                                                                              |
+| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse.                                                                              |
+| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration\[, channel, mem\_slot, …])             | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g.                                                                                  |
+| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration\[, channel, name])                           | A blocking instruction with no other effect.                                                                                                                                 |
+| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name])                                 | This instruction is responsible for applying a pulse on a channel.                                                                                                           |
+| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name])     | Set the channel frequency.                                                                                                                                                   |
+| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase\[, channel, name])               | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel"). |
+| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name])              | An instruction targeted for simulators, to capture a moment in the simulation.                                                                                               |
 
 ## Pulse Library (waveforms )
 

diff --git a/docs/api/qiskit/0.19/qiskit.compiler.assemble.md b/docs/api/qiskit/0.19/qiskit.compiler.assemble.md
@@ -42,7 +42,7 @@ This function serializes the payloads, which could be either circuits or schedul
 
 *   **meas\_lo\_range** (`Optional`\[`List`\[`int`]]) – List of measurement LO ranges each of form `[range_min, range_max]` in Hz. Used to validate the supplied qubit frequencies.
 
-*   **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#qiskit.pulse.channels.PulseChannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz.
+*   **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`]], `Dict`\[[`PulseChannel`](qiskit.pulse.channels#pulsechannel "qiskit.pulse.channels.PulseChannel"), `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz.
 
 *   **meas\_level** (`Union`\[`int`, `MeasLevel`]) – Set the appropriate level of the measurement output for pulse experiments.
 

diff --git a/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md b/docs/api/qiskit/0.19/qiskit.finance.applications.ising.portfolio.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.finance.applications.ising.portfolio.get_operator
+title: portfolio
+description: API reference for qiskit.finance.applications.ising.portfolio
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.finance.applications.ising.portfolio.get_operator
+python_api_type: module
+python_api_name: qiskit.finance.applications.ising.portfolio
 ---
 
 <span id="qiskit-finance-applications-ising-portfolio" />

diff --git a/.../api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md b/.../api/qiskit/0.19/qiskit.finance.applications.ising.portfolio_diversification.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.finance.applications.ising.portfolio_diversification.get_operator
+title: portfolio_diversification
+description: API reference for qiskit.finance.applications.ising.portfolio_diversification
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.finance.applications.ising.portfolio_diversification.get_operator
+python_api_type: module
+python_api_name: qiskit.finance.applications.ising.portfolio_diversification
 ---
 
 <span id="qiskit-finance-applications-ising-portfolio-diversification" />

diff --git a/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md b/docs/api/qiskit/0.19/qiskit.ignis.verification.basis.md
@@ -1,3 +1,12 @@
+---
+title: basis
+description: API reference for qiskit.ignis.verification.basis
+in_page_toc_min_heading_level: 1
+python_api_type: module
+python_api_name: qiskit.ignis.verification.basis
+---
+
 # basis
 
 Quantum tomography basis
+
diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.clique.md
@@ -1,9 +1,9 @@
 ---
-title: get_graph_solution
-description: API reference for qiskit.optimization.applications.ising.clique.get_graph_solution
+title: clique
+description: API reference for qiskit.optimization.applications.ising.clique
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.clique.get_graph_solution
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.clique
 ---
 
 <span id="qiskit-optimization-applications-ising-clique" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.docplex.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.optimization.applications.ising.docplex.get_operator
+title: docplex
+description: API reference for qiskit.optimization.applications.ising.docplex
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.docplex.get_operator
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.docplex
 ---
 
 <span id="qiskit-optimization-applications-ising-docplex" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.exact_cover.md
@@ -1,9 +1,9 @@
 ---
-title: check_solution_satisfiability
-description: API reference for qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability
+title: exact_cover
+description: API reference for qiskit.optimization.applications.ising.exact_cover
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.exact_cover.check_solution_satisfiability
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.exact_cover
 ---
 
 <span id="qiskit-optimization-applications-ising-exact-cover" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.graph_partition.md
@@ -1,9 +1,9 @@
 ---
-title: get_graph_solution
-description: API reference for qiskit.optimization.applications.ising.graph_partition.get_graph_solution
+title: graph_partition
+description: API reference for qiskit.optimization.applications.ising.graph_partition
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.graph_partition.get_graph_solution
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.graph_partition
 ---
 
 <span id="qiskit-optimization-applications-ising-graph-partition" />
@@ -50,11 +50,11 @@ Generate Hamiltonian for the graph partitioning
 
 **Notes**
 
-## Goals:
+**Goals:**
 
 1 separate the vertices into two set of the same size 2 make sure the number of edges between the two set is minimized.
 
-## Hamiltonian:
+**Hamiltonian:**
 
 H = H\_A + H\_B H\_A = sum\_\{(i,j)in E}\{(1-ZiZj)/2} H\_B = (sum\_\{i}\{Zi})^2 = sum\_\{i}\{Zi^2}+sum\_\{i!=j}\{ZiZj} H\_A is for achieving goal 2 and H\_B is for achieving goal 1.
 

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.knapsack.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.optimization.applications.ising.knapsack.get_operator
+title: knapsack
+description: API reference for qiskit.optimization.applications.ising.knapsack
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.knapsack.get_operator
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.knapsack
 ---
 
 <span id="qiskit-optimization-applications-ising-knapsack" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.max_cut.md
@@ -1,9 +1,9 @@
 ---
-title: get_graph_solution
-description: API reference for qiskit.optimization.applications.ising.max_cut.get_graph_solution
+title: max_cut
+description: API reference for qiskit.optimization.applications.ising.max_cut
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.max_cut.get_graph_solution
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.max_cut
 ---
 
 <span id="qiskit-optimization-applications-ising-max-cut" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.partition.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.optimization.applications.ising.partition.get_operator
+title: partition
+description: API reference for qiskit.optimization.applications.ising.partition
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.partition.get_operator
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.partition
 ---
 
 <span id="qiskit-optimization-applications-ising-partition" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.set_packing.md
@@ -1,9 +1,9 @@
 ---
-title: check_disjoint
-description: API reference for qiskit.optimization.applications.ising.set_packing.check_disjoint
+title: set_packing
+description: API reference for qiskit.optimization.applications.ising.set_packing
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.set_packing.check_disjoint
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.set_packing
 ---
 
 <span id="qiskit-optimization-applications-ising-set-packing" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.stable_set.md
@@ -1,9 +1,9 @@
 ---
-title: get_graph_solution
-description: API reference for qiskit.optimization.applications.ising.stable_set.get_graph_solution
+title: stable_set
+description: API reference for qiskit.optimization.applications.ising.stable_set
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.stable_set.get_graph_solution
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.stable_set
 ---
 
 <span id="qiskit-optimization-applications-ising-stable-set" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.md
@@ -1,9 +1,9 @@
 ---
-title: TspData
-description: API reference for qiskit.optimization.applications.ising.tsp.TspData
+title: tsp
+description: API reference for qiskit.optimization.applications.ising.tsp
 in_page_toc_min_heading_level: 1
-python_api_type: class
-python_api_name: qiskit.optimization.applications.ising.tsp.TspData
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.tsp
 ---
 
 <span id="qiskit-optimization-applications-ising-tsp" />

diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vehicle_routing.md
@@ -1,9 +1,9 @@
 ---
-title: get_operator
-description: API reference for qiskit.optimization.applications.ising.vehicle_routing.get_operator
+title: vehicle_routing
+description: API reference for qiskit.optimization.applications.ising.vehicle_routing
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.vehicle_routing.get_operator
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.vehicle_routing
 ---
 
 <span id="qiskit-optimization-applications-ising-vehicle-routing" />
@@ -72,7 +72,7 @@ float
 
 `get_vehiclerouting_matrices(instance, n, K)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code")
 
-## Constructs auxiliary matrices from a vehicle routing instance,
+**Constructs auxiliary matrices from a vehicle routing instance,**
 
 which represent the encoding into a binary quadratic program. This is used in the construction of the qubit ops and computation of the solution cost.
 
@@ -96,7 +96,7 @@ tuple(numpy.ndarray, numpy.ndarray, float)
 
 `get_vehiclerouting_solution(instance, n, K, result)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.7/qiskit/optimization/applications/ising/vehicle_routing.py "view source code")
 
-## Tries to obtain a feasible solution (in vector form) of an instance
+**Tries to obtain a feasible solution (in vector form) of an instance**
 
 of vehicle routing from the results dictionary.
 
@@ -115,7 +115,7 @@ a solution, i.e., a path, in its binary representation.
 
 numpy.ndarray
 
-## #TODO: support statevector simulation, results should be a statevector or counts format, not
+**#TODO: support statevector simulation, results should be a statevector or counts format, not**
 
 a result from algorithm run
 
diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.vertex_cover.md
@@ -1,9 +1,9 @@
 ---
-title: check_full_edge_coverage
-description: API reference for qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage
+title: vertex_cover
+description: API reference for qiskit.optimization.applications.ising.vertex_cover
 in_page_toc_min_heading_level: 1
-python_api_type: function
-python_api_name: qiskit.optimization.applications.ising.vertex_cover.check_full_edge_coverage
+python_api_type: module
+python_api_name: qiskit.optimization.applications.ising.vertex_cover
 ---
 
 <span id="qiskit-optimization-applications-ising-vertex-cover" />

diff --git a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.md
@@ -94,7 +94,7 @@ Return the acquisition channel for the given qubit.
 
 **Return type**
 
-[`AcquireChannel`](qiskit.pulse.channels#qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")
+[`AcquireChannel`](qiskit.pulse.channels#acquirechannel "qiskit.pulse.channels.AcquireChannel")
 
 **Returns**
 
@@ -119,7 +119,7 @@ Return the secondary drive channel for the given qubit – typically utilized fo
 
 **Return type**
 
-`List`\[[`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")]
+`List`\[[`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")]
 
 **Returns**
 
@@ -149,15 +149,15 @@ backend.configuration().describe(ControlChannel(1))
 
 **Parameters**
 
-**channel** ([`ControlChannel`](qiskit.pulse.channels#qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe.
+**channel** ([`ControlChannel`](qiskit.pulse.channels#controlchannel "qiskit.pulse.channels.ControlChannel")) – The derived channel to describe.
 
 **Raises**
 
 **BackendConfigurationError** – If channel is not a ControlChannel.
 
 **Return type**
 
-`Dict`\[[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel"), `complex`]
+`Dict`\[[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel"), `complex`]
 
 **Returns**
 
@@ -177,7 +177,7 @@ Return the drive channel for the given qubit.
 
 **Return type**
 
-[`DriveChannel`](qiskit.pulse.channels#qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel")
+[`DriveChannel`](qiskit.pulse.channels#drivechannel "qiskit.pulse.channels.DriveChannel")
 
 **Returns**
 
@@ -237,7 +237,7 @@ Return a list of channels which operate on the given `qubit`.
 
 **Return type**
 
-`List`\[[`Channel`](qiskit.pulse.channels#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")]
+`List`\[[`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel")]
 
 **Returns**
 
@@ -257,7 +257,7 @@ Return the measure stimulus channel for the given qubit.
 
 **Return type**
 
-[`MeasureChannel`](qiskit.pulse.channels#qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel")
+[`MeasureChannel`](qiskit.pulse.channels#measurechannel "qiskit.pulse.channels.MeasureChannel")
 
 **Returns**