Skip to content

Commit

Permalink
Merge branch 'main' into refactor-processHtml2
Browse files Browse the repository at this point in the history
  • Loading branch information
@arnaucasau
arnaucasau committed Mar 5, 2024
2 parents dcdc823 + a09d4bf commit 48ac19f
Show file tree
Hide file tree
Showing 2,313 changed files with 2,935 additions and 2,626 deletions.
1 change: 1 addition & 0 deletions .gitattributes
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
objects.inv diff=objects_inv
16 changes: 16 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,22 @@ Follow the same process above for new API docs, other than:

If the version is not for the latest stable minor release series, then add `--historical` to the arguments. For example, use `--historical` if the latest stable release is 0.45.\* but you're generating docs for the patch release 0.44.3.

### View diff for `objects.inv`

Since `objects.inv` is compressed, we can't review changes through `git diff`. Git _does_ tell you if the file has changed, but this isn't that helpful as the compressed file can be different even if the uncompressed contents are the same.
If you want to see the diff for the uncompressed contents, first install [`sphobjinv`](https://github.com/bskinn/sphobjinv).

```sh
pipx install sphobjinv
```

The add the following to your `.gitconfig` (usually found at `~/.gitconfig`).

```
[diff "objects_inv"]
textconv = sh -c 'sphobjinv convert plain "$0" -'
```

# How to write the documentation

We use [MDX](https://mdxjs.com), which is like normal markdown but adds extensions for custom components we have.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_job.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_jupyter.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_provider.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_transpiler.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_utils.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/ibm_visualization.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.basis.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion ...api/qiskit-ibm-provider/0.7/qiskit_ibm_provider.transpiler.passes.scheduling.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_job.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_jupyter.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_provider.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_transpiler.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_utils.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/ibm_visualization.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.basis.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion ...api/qiskit-ibm-provider/0.8/qiskit_ibm_provider.transpiler.passes.scheduling.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_job.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_jupyter.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_provider.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_transpiler.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_utils.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/ibm_visualization.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.basis.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion ...api/qiskit-ibm-provider/0.9/qiskit_ibm_provider.transpiler.passes.scheduling.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_job.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_jupyter.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_provider.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_transpiler.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_utils.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/ibm_visualization.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.14/options.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.14/runtime_service.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.15/options.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.15/runtime_service.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/0.16/options.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
Loading

0 comments on commit 48ac19f

Please sign in to comment.