Generate API docs (#65)

Closes #9. Once this lands, we will update the closed source repository to start consuming this repository and remove the API pipeline from there. Note that these API docs are not identical to the closed source versions! This uses qiskit-ibm-provider 0.7 rather than 0.6.3, and qiskit-ibm-runtime 0.12.2 rather than 0.11.3. We skip spellcheck issues and the metadata check for certain files (#66) to facilitate landing this. They were already issues in closed source.
Qiskit · Oct 2, 2023 · ab783b4 · ab783b4
1 parent e872441
commit ab783b4
Show file tree

Hide file tree

Showing 792 changed files with 130,130 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@
 
 node_modules
 tsconfig.tsbuildinfo
+
+.out/
diff --git a/cSpell.json b/cSpell.json
@@ -259,5 +259,9 @@
     "\\S+_\\S+(_\\S+)*",
     // separate line <span id="" /> tags
     "^<span id=\\S+ />$"
+  ],
+  "ignorePaths": [
+    // We cannot easily control these API docs since they live in other repositories.
+    "docs/api"
   ]
 }
diff --git a/docs/api/qiskit-ibm-provider/_toc.json b/docs/api/qiskit-ibm-provider/_toc.json
@@ -0,0 +1,213 @@
+{
+  "title": "Qiskit IBM Provider",
+  "subtitle": "v0.7.0",
+  "children": [
+    {
+      "title": "qiskit_ibm_provider",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/ibm_provider"
+        },
+        {
+          "title": "IBMBackend",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend"
+        },
+        {
+          "title": "IBMBackendApiError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError"
+        },
+        {
+          "title": "IBMBackendApiProtocolError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError"
+        },
+        {
+          "title": "IBMBackendError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError"
+        },
+        {
+          "title": "IBMBackendService",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService"
+        },
+        {
+          "title": "IBMBackendValueError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError"
+        },
+        {
+          "title": "IBMError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError"
+        },
+        {
+          "title": "IBMProvider",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider"
+        },
+        {
+          "title": "IBMProviderError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError"
+        },
+        {
+          "title": "IBMProviderValueError",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError"
+        },
+        {
+          "title": "least_busy",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy"
+        },
+        {
+          "title": "qiskit_ibm_provider.jupyter",
+          "url": "/api/qiskit-ibm-provider/ibm_jupyter"
+        },
+        {
+          "title": "Session",
+          "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.Session"
+        },
+        {
+          "title": "qiskit_ibm_provider.job",
+          "children": [
+            {
+              "title": "Overview",
+              "url": "/api/qiskit-ibm-provider/ibm_job"
+            },
+            {
+              "title": "IBMCircuitJob",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob"
+            },
+            {
+              "title": "IBMCompositeJob",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob"
+            },
+            {
+              "title": "IBMJobApiError",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError"
+            },
+            {
+              "title": "IBMJobError",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError"
+            },
+            {
+              "title": "IBMJobFailureError",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError"
+            },
+            {
+              "title": "IBMJobInvalidStateError",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError"
+            },
+            {
+              "title": "IBMJobTimeoutError",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError"
+            },
+            {
+              "title": "job_monitor",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor"
+            },
+            {
+              "title": "QueueInfo",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo"
+            }
+          ]
+        },
+        {
+          "title": "qiskit_ibm_provider.transpiler",
+          "children": [
+            {
+              "title": "Overview",
+              "url": "/api/qiskit-ibm-provider/ibm_transpiler"
+            },
+            {
+              "title": "qiskit_ibm_provider.transpiler.passes",
+              "children": [
+                {
+                  "title": "Overview",
+                  "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes"
+                },
+                {
+                  "title": "qiskit_ibm_provider.transpiler.passes.basis",
+                  "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis"
+                },
+                {
+                  "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
+                  "children": [
+                    {
+                      "title": "Overview",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling"
+                    },
+                    {
+                      "title": "ALAPScheduleAnalysis",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+                    },
+                    {
+                      "title": "ASAPScheduleAnalysis",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+                    },
+                    {
+                      "title": "BlockBasePadder",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+                    },
+                    {
+                      "title": "DynamicCircuitInstructionDurations",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+                    },
+                    {
+                      "title": "PadDelay",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+                    },
+                    {
+                      "title": "PadDynamicalDecoupling",
+                      "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "title": "qiskit_ibm_provider.utils",
+          "children": [
+            {
+              "title": "Overview",
+              "url": "/api/qiskit-ibm-provider/ibm_utils"
+            },
+            {
+              "title": "seconds_to_duration",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration"
+            },
+            {
+              "title": "to_python_identifier",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier"
+            },
+            {
+              "title": "utc_to_local",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local"
+            },
+            {
+              "title": "validate_job_tags",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags"
+            }
+          ]
+        },
+        {
+          "title": "qiskit_ibm_provider.visualization",
+          "children": [
+            {
+              "title": "Overview",
+              "url": "/api/qiskit-ibm-provider/ibm_visualization"
+            },
+            {
+              "title": "iplot_error_map",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map"
+            },
+            {
+              "title": "iplot_gate_map",
+              "url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "title": "Changelog",
+      "url": "https://github.com/qiskit/qiskit-ibm-provider/releases"
+    }
+  ]
+}
diff --git a/docs/api/qiskit-ibm-provider/ibm-provider.md b/docs/api/qiskit-ibm-provider/ibm-provider.md
@@ -0,0 +1,8 @@
+# qiskit-ibm-provider API Reference
+
+*   [IBM Quantum Provider (`qiskit_ibm_provider`)](ibm_provider)
+*   [Job (`qiskit_ibm_provider.job`)](ibm_job)
+*   [Visualizations (`qiskit_ibm_provider.visualization`)](ibm_visualization)
+*   [Jupyter Tools (`qiskit_ibm_provider.jupyter`)](ibm_jupyter)
+*   [Utilities (`qiskit_ibm_provider.utils`)](ibm_utils)
+*   [IBM Backend Transpiler Tools (`qiskit_ibm_provider.transpiler`)](ibm_transpiler)
diff --git a/docs/api/qiskit-ibm-provider/ibm_job.md b/docs/api/qiskit-ibm-provider/ibm_job.md
@@ -0,0 +1,46 @@
+---
+title: job
+description: API reference for qiskit_ibm_provider.job
+in_page_toc_min_heading_level: 1
+python_api_type: module
+python_api_name: qiskit_ibm_provider.job
+---
+
+<span id="module-qiskit_ibm_provider.job" />
+
+<span id="qiskit-ibm-provider-job" />
+
+<span id="job-qiskit-ibm-provider-job" />
+
+# Job
+
+<span id="module-qiskit_ibm_provider.job" />
+
+`qiskit_ibm_provider.job`
+
+Modules representing IBM Quantum jobs.
+
+## Classes
+
+|                                                                                                                                         |                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| [`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.IBMCircuitJob")(backend, api\_client, job\_id\[, ...]) | Representation of a job that executes on an IBM Quantum backend.        |
+| [`IBMCompositeJob`](qiskit_ibm_provider.job.IBMCompositeJob "qiskit_ibm_provider.job.IBMCompositeJob")(backend, api\_client\[, ...])    | Representation of a set of jobs that execute on an IBM Quantum backend. |
+| [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo")(\[position\_in\_queue, status, ...])               | Queue information for a job.                                            |
+
+## Functions
+
+|                                                                                                                      |                                             |
+| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| [`job_monitor`](qiskit_ibm_provider.job.job_monitor "qiskit_ibm_provider.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMJob` instance. |
+
+## Exception
+
+|                                                                                                                                           |                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| [`IBMJobError`](qiskit_ibm_provider.job.IBMJobError "qiskit_ibm_provider.job.IBMJobError")(\*message)                                     | Base class for errors raised by the job modules.                    |
+| [`IBMJobApiError`](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError")(\*message)                            | Errors that occur unexpectedly when querying the server.            |
+| [`IBMJobFailureError`](qiskit_ibm_provider.job.IBMJobFailureError "qiskit_ibm_provider.job.IBMJobFailureError")(\*message)                | Errors raised when a job failed.                                    |
+| [`IBMJobInvalidStateError`](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError")(\*message) | Errors raised when a job is not in a valid state for the operation. |
+| [`IBMJobTimeoutError`](qiskit_ibm_provider.job.IBMJobTimeoutError "qiskit_ibm_provider.job.IBMJobTimeoutError")(\*message)                | Errors raised when a job operation times out.                       |
+
diff --git a/docs/api/qiskit-ibm-provider/ibm_jupyter.md b/docs/api/qiskit-ibm-provider/ibm_jupyter.md
@@ -0,0 +1,57 @@
+---
+title: jupyter
+description: API reference for qiskit_ibm_provider.jupyter
+in_page_toc_min_heading_level: 1
+python_api_type: module
+python_api_name: qiskit_ibm_provider.jupyter
+---
+
+<span id="module-qiskit_ibm_provider.jupyter" />
+
+<span id="qiskit-ibm-provider-jupyter" />
+
+<span id="jupyter-tools-qiskit-ibm-provider-jupyter" />
+
+# Jupyter Tools
+
+<span id="module-qiskit_ibm_provider.jupyter" />
+
+`qiskit_ibm_provider.jupyter`
+
+A Collection of Jupyter magic functions and tools that extend the functionality of Qiskit for the IBM Quantum devices.
+
+<Admonition title="Note" type="note">
+  To use these tools locally, you’ll need to install the additional dependencies for the visualization functions:
+
+  ```python
+  pip install qiskit_ibm_provider[visualization]
+  ```
+</Admonition>
+
+## Detailed information on a single backend
+
+```python
+from qiskit_ibm_provider import IBMProvider
+import qiskit_ibm_provider.jupyter
+
+provider = IBMProvider(hub='ibm-q')
+backend = provider.get_backend('ibmq_vigo')
+```
+
+```python
+backend
+```
+
+```python
+<FakeVigo('fake_vigo')>
+```
+
+## IBM Quantum dashboard
+
+```python
+from qiskit_ibm_provider import IBMProvider
+import qiskit_ibm_provider.jupyter
+
+%ibm_quantum_dashboard
+```
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,5 @@

		node_modules
		tsconfig.tsbuildinfo

		.out/