Add versions to API metadata & autogenerate index page metadata (#2241)

An issue with our API docs is confusing which version specific pages correspond to because we have so many duplicates. That is especially an issue with SEO, but also rich previews & tab titles. So, this PR adds the version to both the `title` and `description`. We use minor versions rather than patch versions because search engines can be slow to update and we don't want their metadata to be out-of-date. Likewise, we call it `(latest version)` and `(dev version)` for this same reason. Finally, this PR automates setting metadata for the index page whereas before we hardcoded it.
Qiskit · Nov 6, 2024 · aa8e078 · aa8e078
1 parent a4deec7
commit aa8e078
Show file tree

Hide file tree

Showing 30,540 changed files with 61,145 additions and 61,207 deletions.
diff --git a/docs/api/qiskit-addon-cutting/index.mdx b/docs/api/qiskit-addon-cutting/index.mdx
@@ -1,3 +1,8 @@
+---
+title: Circuit cutting API documentation (latest version)
+description: Index of all the modules in the latest version of qiskit-addon-cutting.
+---
+
 <span id="qiskit-addon-cutting-api-reference" />
 
 # `qiskit-addon-cutting` API reference
@@ -11,3 +16,4 @@
 *   [Simulation utilities (`qiskit_addon_cutting.utils.simulation`)](utils-simulation)
 *   [Transforms (`qiskit_addon_cutting.utils.transforms`)](utils-transforms)
 *   [Transpiler passes (`qiskit_addon_cutting.utils.transpiler_passes`)](utils-transpiler-passes)
+
diff --git a/docs/api/qiskit-addon-cutting/instructions.mdx b/docs/api/qiskit-addon-cutting/instructions.mdx
@@ -1,6 +1,6 @@
 ---
-title: instructions
-description: API reference for qiskit_addon_cutting.instructions
+title: instructions (latest version)
+description: API reference for qiskit_addon_cutting.instructions in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.instructions

diff --git a/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx b/docs/api/qiskit-addon-cutting/qiskit-addon-cutting.mdx
@@ -1,6 +1,6 @@
 ---
-title: qiskit_addon_cutting
-description: API reference for qiskit_addon_cutting
+title: qiskit_addon_cutting (latest version)
+description: API reference for qiskit_addon_cutting in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting

diff --git a/docs/api/qiskit-addon-cutting/qpd.mdx b/docs/api/qiskit-addon-cutting/qpd.mdx
@@ -1,6 +1,6 @@
 ---
-title: qpd
-description: API reference for qiskit_addon_cutting.qpd
+title: qpd (latest version)
+description: API reference for qiskit_addon_cutting.qpd in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.qpd

diff --git a/docs/api/qiskit-addon-cutting/utils-bitwise.mdx b/docs/api/qiskit-addon-cutting/utils-bitwise.mdx
@@ -1,6 +1,6 @@
 ---
-title: bitwise
-description: API reference for qiskit_addon_cutting.utils.bitwise
+title: bitwise (latest version)
+description: API reference for qiskit_addon_cutting.utils.bitwise in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.bitwise

diff --git a/docs/api/qiskit-addon-cutting/utils-iteration.mdx b/docs/api/qiskit-addon-cutting/utils-iteration.mdx
@@ -1,6 +1,6 @@
 ---
-title: iteration
-description: API reference for qiskit_addon_cutting.utils.iteration
+title: iteration (latest version)
+description: API reference for qiskit_addon_cutting.utils.iteration in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.iteration

diff --git a/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx b/docs/api/qiskit-addon-cutting/utils-observable-grouping.mdx
@@ -1,6 +1,6 @@
 ---
-title: observable_grouping
-description: API reference for qiskit_addon_cutting.utils.observable_grouping
+title: observable_grouping (latest version)
+description: API reference for qiskit_addon_cutting.utils.observable_grouping in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.observable_grouping

diff --git a/docs/api/qiskit-addon-cutting/utils-simulation.mdx b/docs/api/qiskit-addon-cutting/utils-simulation.mdx
@@ -1,6 +1,6 @@
 ---
-title: simulation
-description: API reference for qiskit_addon_cutting.utils.simulation
+title: simulation (latest version)
+description: API reference for qiskit_addon_cutting.utils.simulation in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.simulation

diff --git a/docs/api/qiskit-addon-cutting/utils-transforms.mdx b/docs/api/qiskit-addon-cutting/utils-transforms.mdx
@@ -1,6 +1,6 @@
 ---
-title: transforms
-description: API reference for qiskit_addon_cutting.utils.transforms
+title: transforms (latest version)
+description: API reference for qiskit_addon_cutting.utils.transforms in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.transforms

diff --git a/docs/api/qiskit-addon-cutting/utils-transpiler-passes.mdx b/docs/api/qiskit-addon-cutting/utils-transpiler-passes.mdx
@@ -1,6 +1,6 @@
 ---
-title: transpiler_passes
-description: API reference for qiskit_addon_cutting.utils.transpiler_passes
+title: transpiler_passes (latest version)
+description: API reference for qiskit_addon_cutting.utils.transpiler_passes in the latest version of qiskit-addon-cutting
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_cutting.utils.transpiler_passes

diff --git a/docs/api/qiskit-addon-mpf/index.mdx b/docs/api/qiskit-addon-mpf/index.mdx
@@ -1,5 +1,11 @@
+---
+title: Multi-product formulas API documentation (latest version)
+description: Index of all the modules in the latest version of qiskit-addon-mpf.
+---
+
 <span id="qiskit-addon-mpf-api-reference" />
 
 # `qiskit-addon-mpf` API reference
 
 *   [Static MPFs (`qiskit_addon_mpf.static`)](static)
+
diff --git a/docs/api/qiskit-addon-mpf/static.mdx b/docs/api/qiskit-addon-mpf/static.mdx
@@ -1,6 +1,6 @@
 ---
-title: static
-description: API reference for qiskit_addon_mpf.static
+title: static (latest version)
+description: API reference for qiskit_addon_mpf.static in the latest version of qiskit-addon-mpf
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_mpf.static

diff --git a/docs/api/qiskit-addon-obp/index.mdx b/docs/api/qiskit-addon-obp/index.mdx
@@ -1,3 +1,8 @@
+---
+title: Operator backpropagation API documentation (latest version)
+description: Index of all the modules in the latest version of qiskit-addon-obp.
+---
+
 <span id="qiskit-addon-obp-api-reference" />
 
 # `qiskit-addon-obp` API reference
@@ -8,3 +13,4 @@
 *   [Pauli operator simplification (`qiskit_addon_obp.utils.simplify`)](utils-simplify)
 *   [Truncation utilities (`qiskit_addon_obp.utils.truncating`)](utils-truncating)
 *   [Visualization utilities (`qiskit_addon_obp.utils.visualization`)](utils-visualization)
+
diff --git a/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx b/docs/api/qiskit-addon-obp/qiskit-addon-obp.mdx
@@ -1,6 +1,6 @@
 ---
-title: qiskit_addon_obp
-description: API reference for qiskit_addon_obp
+title: qiskit_addon_obp (latest version)
+description: API reference for qiskit_addon_obp in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp

diff --git a/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx b/docs/api/qiskit-addon-obp/utils-metadata-obp-metadata.mdx
@@ -1,6 +1,6 @@
 ---
-title: OBPMetadata
-description: API reference for qiskit_addon_obp.utils.metadata.OBPMetadata
+title: OBPMetadata (latest version)
+description: API reference for qiskit_addon_obp.utils.metadata.OBPMetadata in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_addon_obp.utils.metadata.OBPMetadata

diff --git a/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx b/docs/api/qiskit-addon-obp/utils-metadata-slice-metadata.mdx
@@ -1,6 +1,6 @@
 ---
-title: SliceMetadata
-description: API reference for qiskit_addon_obp.utils.metadata.SliceMetadata
+title: SliceMetadata (latest version)
+description: API reference for qiskit_addon_obp.utils.metadata.SliceMetadata in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_addon_obp.utils.metadata.SliceMetadata

diff --git a/docs/api/qiskit-addon-obp/utils-metadata.mdx b/docs/api/qiskit-addon-obp/utils-metadata.mdx
@@ -1,6 +1,6 @@
 ---
-title: metadata
-description: API reference for qiskit_addon_obp.utils.metadata
+title: metadata (latest version)
+description: API reference for qiskit_addon_obp.utils.metadata in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp.utils.metadata

diff --git a/docs/api/qiskit-addon-obp/utils-operations.mdx b/docs/api/qiskit-addon-obp/utils-operations.mdx
@@ -1,6 +1,6 @@
 ---
-title: operations
-description: API reference for qiskit_addon_obp.utils.operations
+title: operations (latest version)
+description: API reference for qiskit_addon_obp.utils.operations in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp.utils.operations

diff --git a/docs/api/qiskit-addon-obp/utils-simplify.mdx b/docs/api/qiskit-addon-obp/utils-simplify.mdx
@@ -1,6 +1,6 @@
 ---
-title: simplify
-description: API reference for qiskit_addon_obp.utils.simplify
+title: simplify (latest version)
+description: API reference for qiskit_addon_obp.utils.simplify in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp.utils.simplify

diff --git a/docs/api/qiskit-addon-obp/utils-truncating.mdx b/docs/api/qiskit-addon-obp/utils-truncating.mdx
@@ -1,6 +1,6 @@
 ---
-title: truncating
-description: API reference for qiskit_addon_obp.utils.truncating
+title: truncating (latest version)
+description: API reference for qiskit_addon_obp.utils.truncating in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp.utils.truncating

diff --git a/docs/api/qiskit-addon-obp/utils-visualization.mdx b/docs/api/qiskit-addon-obp/utils-visualization.mdx
@@ -1,6 +1,6 @@
 ---
-title: visualization
-description: API reference for qiskit_addon_obp.utils.visualization
+title: visualization (latest version)
+description: API reference for qiskit_addon_obp.utils.visualization in the latest version of qiskit-addon-obp
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_obp.utils.visualization

diff --git a/docs/api/qiskit-addon-sqd/configuration-recovery.mdx b/docs/api/qiskit-addon-sqd/configuration-recovery.mdx
@@ -1,6 +1,6 @@
 ---
-title: configuration_recovery
-description: API reference for qiskit_addon_sqd.configuration_recovery
+title: configuration_recovery (latest version)
+description: API reference for qiskit_addon_sqd.configuration_recovery in the latest version of qiskit-addon-sqd
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_sqd.configuration_recovery

diff --git a/docs/api/qiskit-addon-sqd/counts.mdx b/docs/api/qiskit-addon-sqd/counts.mdx
@@ -1,6 +1,6 @@
 ---
-title: counts
-description: API reference for qiskit_addon_sqd.counts
+title: counts (latest version)
+description: API reference for qiskit_addon_sqd.counts in the latest version of qiskit-addon-sqd
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_sqd.counts

diff --git a/docs/api/qiskit-addon-sqd/fermion.mdx b/docs/api/qiskit-addon-sqd/fermion.mdx
@@ -1,6 +1,6 @@
 ---
-title: fermion
-description: API reference for qiskit_addon_sqd.fermion
+title: fermion (latest version)
+description: API reference for qiskit_addon_sqd.fermion in the latest version of qiskit-addon-sqd
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_sqd.fermion

diff --git a/docs/api/qiskit-addon-sqd/index.mdx b/docs/api/qiskit-addon-sqd/index.mdx
@@ -1,3 +1,8 @@
+---
+title: Sample-based quantum diagonalization API documentation (latest version)
+description: Index of all the modules in the latest version of qiskit-addon-sqd.
+---
+
 <span id="qiskit-addon-sqd-api-reference" />
 
 # `qiskit-addon-sqd` API reference
@@ -7,3 +12,4 @@
 *   [Fermion (`qiskit_addon_sqd.fermion`)](fermion)
 *   [Qubit (`qiskit_addon_sqd.qubit`)](qubit)
 *   [Subsampling (`qiskit_addon_sqd.subsampling`)](subsampling)
+
diff --git a/docs/api/qiskit-addon-sqd/qubit.mdx b/docs/api/qiskit-addon-sqd/qubit.mdx
@@ -1,6 +1,6 @@
 ---
-title: qubit
-description: API reference for qiskit_addon_sqd.qubit
+title: qubit (latest version)
+description: API reference for qiskit_addon_sqd.qubit in the latest version of qiskit-addon-sqd
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_sqd.qubit

diff --git a/docs/api/qiskit-addon-sqd/subsampling.mdx b/docs/api/qiskit-addon-sqd/subsampling.mdx
@@ -1,6 +1,6 @@
 ---
-title: subsampling
-description: API reference for qiskit_addon_sqd.subsampling
+title: subsampling (latest version)
+description: API reference for qiskit_addon_sqd.subsampling in the latest version of qiskit-addon-sqd
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_sqd.subsampling

diff --git a/docs/api/qiskit-addon-utils/coloring.mdx b/docs/api/qiskit-addon-utils/coloring.mdx
@@ -1,6 +1,6 @@
 ---
-title: coloring
-description: API reference for qiskit_addon_utils.coloring
+title: coloring (latest version)
+description: API reference for qiskit_addon_utils.coloring in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_utils.coloring

diff --git a/docs/api/qiskit-addon-utils/index.mdx b/docs/api/qiskit-addon-utils/index.mdx
@@ -1,3 +1,8 @@
+---
+title: Qiskit addon utilities API documentation (latest version)
+description: Index of all the modules in the latest version of qiskit-addon-utils.
+---
+
 <span id="qiskit-addon-utils-api-reference" />
 
 # `qiskit-addon-utils` API reference
@@ -8,3 +13,4 @@ This package contains functionality which is meant to supplement workflows invol
 *   [problem\_generators (`qiskit_addon_utils.problem_generators`)](problem-generators)
 *   [slicing (`qiskit_addon_utils.slicing`)](slicing)
 *   [passes (`qiskit_addon_utils.slicing.transpiler.passes`)](slicing-transpiler-passes)
+
diff --git a/docs/api/qiskit-addon-utils/problem-generators.mdx b/docs/api/qiskit-addon-utils/problem-generators.mdx
@@ -1,6 +1,6 @@
 ---
-title: problem_generators
-description: API reference for qiskit_addon_utils.problem_generators
+title: problem_generators (latest version)
+description: API reference for qiskit_addon_utils.problem_generators in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_utils.problem_generators

diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-color.mdx
@@ -1,6 +1,6 @@
 ---
-title: CollectOpColor
-description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpColor
+title: CollectOpColor (latest version)
+description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpColor in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpColor

diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-size.mdx
@@ -1,6 +1,6 @@
 ---
-title: CollectOpSize
-description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize
+title: CollectOpSize (latest version)
+description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpSize

diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes-collect-op-type.mdx
@@ -1,6 +1,6 @@
 ---
-title: CollectOpType
-description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpType
+title: CollectOpType (latest version)
+description: API reference for qiskit_addon_utils.slicing.transpiler.passes.CollectOpType in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_addon_utils.slicing.transpiler.passes.CollectOpType

diff --git a/docs/api/qiskit-addon-utils/slicing-transpiler-passes.mdx b/docs/api/qiskit-addon-utils/slicing-transpiler-passes.mdx
@@ -1,6 +1,6 @@
 ---
-title: passes
-description: API reference for qiskit_addon_utils.slicing.transpiler.passes
+title: passes (latest version)
+description: API reference for qiskit_addon_utils.slicing.transpiler.passes in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_utils.slicing.transpiler.passes

diff --git a/docs/api/qiskit-addon-utils/slicing.mdx b/docs/api/qiskit-addon-utils/slicing.mdx
@@ -1,6 +1,6 @@
 ---
-title: slicing
-description: API reference for qiskit_addon_utils.slicing
+title: slicing (latest version)
+description: API reference for qiskit_addon_utils.slicing in the latest version of qiskit-addon-utils
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_addon_utils.slicing

diff --git a/docs/api/qiskit-ibm-runtime/0.14/index.mdx b/docs/api/qiskit-ibm-runtime/0.14/index.mdx
@@ -1,6 +1,6 @@
 ---
-title: Qiskit Runtime Client API Docs
-description: API documentation for the qiskit-ibm-runtime client
+title: Qiskit Runtime client API documentation (v0.14)
+description: Index of all the modules in qiskit-ibm-runtime v0.14.
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.14/options.mdx b/docs/api/qiskit-ibm-runtime/0.14/options.mdx
@@ -1,6 +1,6 @@
 ---
-title: options
-description: API reference for qiskit_ibm_runtime.options
+title: options (v0.14)
+description: API reference for qiskit_ibm_runtime.options in qiskit-ibm-runtime v0.14
 in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_runtime.options

diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.mdx
@@ -1,6 +1,6 @@
 ---
-title: Estimator
-description: API reference for qiskit_ibm_runtime.Estimator
+title: Estimator (v0.14)
+description: API reference for qiskit_ibm_runtime.Estimator in qiskit-ibm-runtime v0.14
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_ibm_runtime.Estimator

diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.mdx
@@ -1,6 +1,6 @@
 ---
-title: IBMBackend
-description: API reference for qiskit_ibm_runtime.IBMBackend
+title: IBMBackend (v0.14)
+description: API reference for qiskit_ibm_runtime.IBMBackend in qiskit-ibm-runtime v0.14
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_ibm_runtime.IBMBackend

diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.mdx
@@ -1,6 +1,6 @@
 ---
-title: ParameterNamespace
-description: API reference for qiskit_ibm_runtime.ParameterNamespace
+title: ParameterNamespace (v0.14)
+description: API reference for qiskit_ibm_runtime.ParameterNamespace in qiskit-ibm-runtime v0.14
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_ibm_runtime.ParameterNamespace

diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.mdx
@@ -1,6 +1,6 @@
 ---
-title: QiskitRuntimeService
-description: API reference for qiskit_ibm_runtime.QiskitRuntimeService
+title: QiskitRuntimeService (v0.14)
+description: API reference for qiskit_ibm_runtime.QiskitRuntimeService in qiskit-ibm-runtime v0.14
 in_page_toc_min_heading_level: 1
 python_api_type: class
 python_api_name: qiskit_ibm_runtime.QiskitRuntimeService