Flatten left table of contents for Runtime and Provider (#1241)

Closes #1212. As explained there, this is because: 1. Qiskit SDK is getting a bigger revamp in #1211 and it will also flatten submodules, so we want to be consistent. 2. The module list is so short that it's useful to have the navbar be flatter. It makes things less crowded and more discoverable. Note that some of the Runtime provider pages aren't very useful...I opened #1240 to track that. For now, this is implemented as the `Pkg` constructor setting a boolean argument for whether modules should be nested or not. I'm coming up with an alternative—but similar factoring—while working on #1211. This PR is ~prework. <img width="253" alt="Screenshot 2024-04-24 at 4 02 34 PM" src="https://github.com/Qiskit/documentation/assets/14852634/2bbbaa7f-e187-4170-b2c5-02273e340b07"> <img width="257" alt="Screenshot 2024-04-24 at 4 02 10 PM" src="https://github.com/Qiskit/documentation/assets/14852634/53816ee2-f7ee-4d1d-90a5-64d7795fd776">
Qiskit · Apr 25, 2024 · 122cb1a · 122cb1a
1 parent 375c96e
commit 122cb1a
Show file tree

Hide file tree

Showing 16 changed files with 529 additions and 572 deletions.
diff --git a/docs/api/qiskit-ibm-provider/0.10/_toc.json b/docs/api/qiskit-ibm-provider/0.10/_toc.json
@@ -109,56 +109,46 @@
     },
     {
       "title": "qiskit_ibm_provider.transpiler",
+      "url": "/api/qiskit-ibm-provider/0.10/ibm_transpiler"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes",
+      "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.basis",
+      "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
       "children": [
         {
           "title": "Overview",
-          "url": "/api/qiskit-ibm-provider/0.10/ibm_transpiler"
-        },
-        {
-          "title": "qiskit_ibm_provider.transpiler.passes",
-          "children": [
-            {
-              "title": "Overview",
-              "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.basis",
-              "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
-              "children": [
-                {
-                  "title": "Overview",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling"
-                },
-                {
-                  "title": "ALAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
-                },
-                {
-                  "title": "ASAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
-                },
-                {
-                  "title": "BlockBasePadder",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
-                },
-                {
-                  "title": "DynamicCircuitInstructionDurations",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
-                },
-                {
-                  "title": "PadDelay",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
-                },
-                {
-                  "title": "PadDynamicalDecoupling",
-                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
-                }
-              ]
-            }
-          ]
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling"
+        },
+        {
+          "title": "ALAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+        },
+        {
+          "title": "ASAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+        },
+        {
+          "title": "BlockBasePadder",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+        },
+        {
+          "title": "DynamicCircuitInstructionDurations",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+        },
+        {
+          "title": "PadDelay",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+        },
+        {
+          "title": "PadDynamicalDecoupling",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
         }
       ]
     },

diff --git a/docs/api/qiskit-ibm-provider/0.7/_toc.json b/docs/api/qiskit-ibm-provider/0.7/_toc.json
@@ -109,56 +109,46 @@
     },
     {
       "title": "qiskit_ibm_provider.transpiler",
+      "url": "/api/qiskit-ibm-provider/0.7/ibm_transpiler"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes",
+      "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.basis",
+      "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.basis"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
       "children": [
         {
           "title": "Overview",
-          "url": "/api/qiskit-ibm-provider/0.7/ibm_transpiler"
-        },
-        {
-          "title": "qiskit_ibm_provider.transpiler.passes",
-          "children": [
-            {
-              "title": "Overview",
-              "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.basis",
-              "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.basis"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
-              "children": [
-                {
-                  "title": "Overview",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling"
-                },
-                {
-                  "title": "ALAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
-                },
-                {
-                  "title": "ASAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
-                },
-                {
-                  "title": "BlockBasePadder",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
-                },
-                {
-                  "title": "DynamicCircuitInstructionDurations",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
-                },
-                {
-                  "title": "PadDelay",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
-                },
-                {
-                  "title": "PadDynamicalDecoupling",
-                  "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
-                }
-              ]
-            }
-          ]
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling"
+        },
+        {
+          "title": "ALAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+        },
+        {
+          "title": "ASAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+        },
+        {
+          "title": "BlockBasePadder",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+        },
+        {
+          "title": "DynamicCircuitInstructionDurations",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+        },
+        {
+          "title": "PadDelay",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+        },
+        {
+          "title": "PadDynamicalDecoupling",
+          "url": "/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
         }
       ]
     },

diff --git a/docs/api/qiskit-ibm-provider/0.8/_toc.json b/docs/api/qiskit-ibm-provider/0.8/_toc.json
@@ -109,56 +109,46 @@
     },
     {
       "title": "qiskit_ibm_provider.transpiler",
+      "url": "/api/qiskit-ibm-provider/0.8/ibm_transpiler"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes",
+      "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.basis",
+      "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.basis"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
       "children": [
         {
           "title": "Overview",
-          "url": "/api/qiskit-ibm-provider/0.8/ibm_transpiler"
-        },
-        {
-          "title": "qiskit_ibm_provider.transpiler.passes",
-          "children": [
-            {
-              "title": "Overview",
-              "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.basis",
-              "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.basis"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
-              "children": [
-                {
-                  "title": "Overview",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling"
-                },
-                {
-                  "title": "ALAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
-                },
-                {
-                  "title": "ASAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
-                },
-                {
-                  "title": "BlockBasePadder",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
-                },
-                {
-                  "title": "DynamicCircuitInstructionDurations",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
-                },
-                {
-                  "title": "PadDelay",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
-                },
-                {
-                  "title": "PadDynamicalDecoupling",
-                  "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
-                }
-              ]
-            }
-          ]
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling"
+        },
+        {
+          "title": "ALAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+        },
+        {
+          "title": "ASAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+        },
+        {
+          "title": "BlockBasePadder",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+        },
+        {
+          "title": "DynamicCircuitInstructionDurations",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+        },
+        {
+          "title": "PadDelay",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+        },
+        {
+          "title": "PadDynamicalDecoupling",
+          "url": "/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
         }
       ]
     },

diff --git a/docs/api/qiskit-ibm-provider/0.9/_toc.json b/docs/api/qiskit-ibm-provider/0.9/_toc.json
@@ -109,56 +109,46 @@
     },
     {
       "title": "qiskit_ibm_provider.transpiler",
+      "url": "/api/qiskit-ibm-provider/0.9/ibm_transpiler"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes",
+      "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.basis",
+      "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.basis"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
       "children": [
         {
           "title": "Overview",
-          "url": "/api/qiskit-ibm-provider/0.9/ibm_transpiler"
-        },
-        {
-          "title": "qiskit_ibm_provider.transpiler.passes",
-          "children": [
-            {
-              "title": "Overview",
-              "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.basis",
-              "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.basis"
-            },
-            {
-              "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
-              "children": [
-                {
-                  "title": "Overview",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling"
-                },
-                {
-                  "title": "ALAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
-                },
-                {
-                  "title": "ASAPScheduleAnalysis",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
-                },
-                {
-                  "title": "BlockBasePadder",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
-                },
-                {
-                  "title": "DynamicCircuitInstructionDurations",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
-                },
-                {
-                  "title": "PadDelay",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
-                },
-                {
-                  "title": "PadDynamicalDecoupling",
-                  "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
-                }
-              ]
-            }
-          ]
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling"
+        },
+        {
+          "title": "ALAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+        },
+        {
+          "title": "ASAPScheduleAnalysis",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+        },
+        {
+          "title": "BlockBasePadder",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+        },
+        {
+          "title": "DynamicCircuitInstructionDurations",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+        },
+        {
+          "title": "PadDelay",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+        },
+        {
+          "title": "PadDynamicalDecoupling",
+          "url": "/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
         }
       ]
     },