Don't show h1s in module page table of contents (Qiskit#949)

Closes Qiskit#932. We decided: 1. We are going to keep showing h1s for class and function pages. It's useful because they have non-trivial code at the top level, like their docstring and constructor. It's nice to have the quick way to access the value. 2. For now at least, we won't show h4s in the module pages. There are 8 module pages in the current API docs that use h4s. I think showing h4s improved ~3 of them, and made ~5 worse. So, for now, let's not include them. This can be revisited, especially after Qiskit#942. This regens all APIs but reverts dev docs, which have unrelated changes and will be regenerated in a dedicated PR.
frankharkins · Mar 4, 2024 · 15586fd · 15586fd
1 parent 146e3d9
commit 15586fd
Show file tree

Hide file tree

Showing 2,286 changed files with 2,310 additions and 2,285 deletions.
diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_job.md b/docs/api/qiskit-ibm-provider/0.7/ibm_job.md
@@ -1,7 +1,7 @@
 ---
 title: job
 description: API reference for qiskit_ibm_provider.job
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.job
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_jupyter.md b/docs/api/qiskit-ibm-provider/0.7/ibm_jupyter.md
@@ -1,7 +1,7 @@
 ---
 title: jupyter
 description: API reference for qiskit_ibm_provider.jupyter
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.jupyter
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_provider.md b/docs/api/qiskit-ibm-provider/0.7/ibm_provider.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_provider
 description: API reference for qiskit_ibm_provider
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_transpiler.md b/docs/api/qiskit-ibm-provider/0.7/ibm_transpiler.md
@@ -1,7 +1,7 @@
 ---
 title: transpiler
 description: API reference for qiskit_ibm_provider.transpiler
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_utils.md b/docs/api/qiskit-ibm-provider/0.7/ibm_utils.md
@@ -1,7 +1,7 @@
 ---
 title: utils
 description: API reference for qiskit_ibm_provider.utils
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.utils
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/ibm_visualization.md b/docs/api/qiskit-ibm-provider/0.7/ibm_visualization.md
@@ -1,7 +1,7 @@
 ---
 title: visualization
 description: API reference for qiskit_ibm_provider.visualization
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.visualization
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.basis.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.basis.md
@@ -1,7 +1,7 @@
 ---
 title: basis
 description: API reference for qiskit_ibm_provider.transpiler.passes.basis
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.basis
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.md b/docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.md
@@ -1,7 +1,7 @@
 ---
 title: passes
 description: API reference for qiskit_ibm_provider.transpiler.passes
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes
 ---

diff --git a/...api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.md b/...api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.md
@@ -1,7 +1,7 @@
 ---
 title: scheduling
 description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_job.md b/docs/api/qiskit-ibm-provider/0.8/ibm_job.md
@@ -1,7 +1,7 @@
 ---
 title: job
 description: API reference for qiskit_ibm_provider.job
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.job
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_jupyter.md b/docs/api/qiskit-ibm-provider/0.8/ibm_jupyter.md
@@ -1,7 +1,7 @@
 ---
 title: jupyter
 description: API reference for qiskit_ibm_provider.jupyter
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.jupyter
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_provider.md b/docs/api/qiskit-ibm-provider/0.8/ibm_provider.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_provider
 description: API reference for qiskit_ibm_provider
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_transpiler.md b/docs/api/qiskit-ibm-provider/0.8/ibm_transpiler.md
@@ -1,7 +1,7 @@
 ---
 title: transpiler
 description: API reference for qiskit_ibm_provider.transpiler
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_utils.md b/docs/api/qiskit-ibm-provider/0.8/ibm_utils.md
@@ -1,7 +1,7 @@
 ---
 title: utils
 description: API reference for qiskit_ibm_provider.utils
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.utils
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/ibm_visualization.md b/docs/api/qiskit-ibm-provider/0.8/ibm_visualization.md
@@ -1,7 +1,7 @@
 ---
 title: visualization
 description: API reference for qiskit_ibm_provider.visualization
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.visualization
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.basis.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.basis.md
@@ -1,7 +1,7 @@
 ---
 title: basis
 description: API reference for qiskit_ibm_provider.transpiler.passes.basis
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.basis
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.md b/docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.md
@@ -1,7 +1,7 @@
 ---
 title: passes
 description: API reference for qiskit_ibm_provider.transpiler.passes
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes
 ---

diff --git a/...api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.md b/...api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.md
@@ -1,7 +1,7 @@
 ---
 title: scheduling
 description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_job.md b/docs/api/qiskit-ibm-provider/0.9/ibm_job.md
@@ -1,7 +1,7 @@
 ---
 title: job
 description: API reference for qiskit_ibm_provider.job
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.job
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_jupyter.md b/docs/api/qiskit-ibm-provider/0.9/ibm_jupyter.md
@@ -1,7 +1,7 @@
 ---
 title: jupyter
 description: API reference for qiskit_ibm_provider.jupyter
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.jupyter
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_provider.md b/docs/api/qiskit-ibm-provider/0.9/ibm_provider.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_provider
 description: API reference for qiskit_ibm_provider
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_transpiler.md b/docs/api/qiskit-ibm-provider/0.9/ibm_transpiler.md
@@ -1,7 +1,7 @@
 ---
 title: transpiler
 description: API reference for qiskit_ibm_provider.transpiler
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md b/docs/api/qiskit-ibm-provider/0.9/ibm_utils.md
@@ -1,7 +1,7 @@
 ---
 title: utils
 description: API reference for qiskit_ibm_provider.utils
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.utils
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/ibm_visualization.md b/docs/api/qiskit-ibm-provider/0.9/ibm_visualization.md
@@ -1,7 +1,7 @@
 ---
 title: visualization
 description: API reference for qiskit_ibm_provider.visualization
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.visualization
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.basis.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.basis.md
@@ -1,7 +1,7 @@
 ---
 title: basis
 description: API reference for qiskit_ibm_provider.transpiler.passes.basis
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.basis
 ---

diff --git a/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.md b/docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.md
@@ -1,7 +1,7 @@
 ---
 title: passes
 description: API reference for qiskit_ibm_provider.transpiler.passes
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes
 ---

diff --git a/...api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md b/...api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md
@@ -1,7 +1,7 @@
 ---
 title: scheduling
 description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_job.md b/docs/api/qiskit-ibm-provider/ibm_job.md
@@ -1,7 +1,7 @@
 ---
 title: job
 description: API reference for qiskit_ibm_provider.job
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.job
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_jupyter.md b/docs/api/qiskit-ibm-provider/ibm_jupyter.md
@@ -1,7 +1,7 @@
 ---
 title: jupyter
 description: API reference for qiskit_ibm_provider.jupyter
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.jupyter
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_provider.md b/docs/api/qiskit-ibm-provider/ibm_provider.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_provider
 description: API reference for qiskit_ibm_provider
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_transpiler.md b/docs/api/qiskit-ibm-provider/ibm_transpiler.md
@@ -1,7 +1,7 @@
 ---
 title: transpiler
 description: API reference for qiskit_ibm_provider.transpiler
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_utils.md b/docs/api/qiskit-ibm-provider/ibm_utils.md
@@ -1,7 +1,7 @@
 ---
 title: utils
 description: API reference for qiskit_ibm_provider.utils
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.utils
 ---

diff --git a/docs/api/qiskit-ibm-provider/ibm_visualization.md b/docs/api/qiskit-ibm-provider/ibm_visualization.md
@@ -1,7 +1,7 @@
 ---
 title: visualization
 description: API reference for qiskit_ibm_provider.visualization
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.visualization
 ---

diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis.md
@@ -1,7 +1,7 @@
 ---
 title: basis
 description: API reference for qiskit_ibm_provider.transpiler.passes.basis
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.basis
 ---

diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.md
@@ -1,7 +1,7 @@
 ---
 title: passes
 description: API reference for qiskit_ibm_provider.transpiler.passes
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes
 ---

diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md
@@ -1,7 +1,7 @@
 ---
 title: scheduling
 description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling
 ---

diff --git a/docs/api/qiskit-ibm-runtime/0.14/options.md b/docs/api/qiskit-ibm-runtime/0.14/options.md
@@ -1,7 +1,7 @@
 ---
 title: options
 description: API reference for qiskit_ibm_runtime.options
-in_page_toc_min_heading_level: 1
+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/runtime_service.md b/docs/api/qiskit-ibm-runtime/0.14/runtime_service.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_runtime
 description: API reference for qiskit_ibm_runtime
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_runtime
 ---

diff --git a/docs/api/qiskit-ibm-runtime/0.15/options.md b/docs/api/qiskit-ibm-runtime/0.15/options.md
@@ -1,7 +1,7 @@
 ---
 title: options
 description: API reference for qiskit_ibm_runtime.options
-in_page_toc_min_heading_level: 1
+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.15/runtime_service.md b/docs/api/qiskit-ibm-runtime/0.15/runtime_service.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_runtime
 description: API reference for qiskit_ibm_runtime
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_runtime
 ---

diff --git a/docs/api/qiskit-ibm-runtime/0.16/options.md b/docs/api/qiskit-ibm-runtime/0.16/options.md
@@ -1,7 +1,7 @@
 ---
 title: options
 description: API reference for qiskit_ibm_runtime.options
-in_page_toc_min_heading_level: 1
+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.16/runtime_service.md b/docs/api/qiskit-ibm-runtime/0.16/runtime_service.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_runtime
 description: API reference for qiskit_ibm_runtime
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_runtime
 ---

diff --git a/docs/api/qiskit-ibm-runtime/0.17/options.md b/docs/api/qiskit-ibm-runtime/0.17/options.md
@@ -1,7 +1,7 @@
 ---
 title: options
 description: API reference for qiskit_ibm_runtime.options
-in_page_toc_min_heading_level: 1
+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.17/runtime_service.md b/docs/api/qiskit-ibm-runtime/0.17/runtime_service.md
@@ -1,7 +1,7 @@
 ---
 title: qiskit_ibm_runtime
 description: API reference for qiskit_ibm_runtime
-in_page_toc_min_heading_level: 1
+in_page_toc_min_heading_level: 2
 python_api_type: module
 python_api_name: qiskit_ibm_runtime
 ---