Skip to content

Commit

Permalink
Regeneration Qiskit v0.35 API docs (Qiskit#682)
Browse files Browse the repository at this point in the history 
Part of Qiskit#542.

Regeneration of the Qiskit API docs (historical versions) with the
methods inlined and the GitHub source links. Given the number of files
modified, the regeneration is split into different PRs. This one only
updates the version 0.35.

In addition, this PR corrects one part of the problem we have with
versions 0.36, 0.35, and 0.34 described in Qiskit#681. Those three versions
have the documentation of the next version instead of its own. The rest
of the versions will be corrected in a follow-up.

All the GitHub source links work!
  • Loading branch information
@arnaucasau
arnaucasau authored Jan 23, 2024
1 parent 47e6660 commit fbaffab
Show file tree
Hide file tree
Showing 1,052 changed files with 92,389 additions and 13,439 deletions.
4,393 changes: 4,252 additions & 141 deletions docs/api/qiskit/0.35/_toc.json
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/api/qiskit/0.35/aer_extensions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ python_api_name: qiskit.providers.aer.extensions

Snapshot instructions allow taking a snapshot of the current state of the simulator without effecting the outcome of the simulation. These can be used with the QasmSimulator backend to return the expectation value of an operator or the probability of measurement outcomes.

| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [`Snapshot`](qiskit.providers.aer.extensions.Snapshot#qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. |
| [`SnapshotProbabilities`](qiskit.providers.aer.extensions.SnapshotProbabilities#qiskit.providers.aer.extensions.SnapshotProbabilities "qiskit.providers.aer.extensions.SnapshotProbabilities")(label, num\_qubits\[, …]) | Snapshot instruction for all methods of Qasm simulator. |
| [`SnapshotExpectationValue`](qiskit.providers.aer.extensions.SnapshotExpectationValue#qiskit.providers.aer.extensions.SnapshotExpectationValue "qiskit.providers.aer.extensions.SnapshotExpectationValue")(label, op\[, …]) | Snapshot instruction for supported methods of Qasm simulator. |
| [`SnapshotStatevector`](qiskit.providers.aer.extensions.SnapshotStatevector#qiskit.providers.aer.extensions.SnapshotStatevector "qiskit.providers.aer.extensions.SnapshotStatevector")(label\[, num\_qubits]) | Snapshot instruction for statevector snapshot type |
| [`SnapshotDensityMatrix`](qiskit.providers.aer.extensions.SnapshotDensityMatrix#qiskit.providers.aer.extensions.SnapshotDensityMatrix "qiskit.providers.aer.extensions.SnapshotDensityMatrix")(label, num\_qubits) | Snapshot instruction for density matrix method of Qasm simulator. |
| [`SnapshotStabilizer`](qiskit.providers.aer.extensions.SnapshotStabilizer#qiskit.providers.aer.extensions.SnapshotStabilizer "qiskit.providers.aer.extensions.SnapshotStabilizer")(label\[, num\_qubits]) | Snapshot instruction for stabilizer method of Qasm simulator. |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| [`Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. |
| [`SnapshotProbabilities`](qiskit.providers.aer.extensions.SnapshotProbabilities "qiskit.providers.aer.extensions.SnapshotProbabilities")(label, num\_qubits\[, …]) | Snapshot instruction for all methods of Qasm simulator. |
| [`SnapshotExpectationValue`](qiskit.providers.aer.extensions.SnapshotExpectationValue "qiskit.providers.aer.extensions.SnapshotExpectationValue")(label, op\[, …]) | Snapshot instruction for supported methods of Qasm simulator. |
| [`SnapshotStatevector`](qiskit.providers.aer.extensions.SnapshotStatevector "qiskit.providers.aer.extensions.SnapshotStatevector")(label\[, num\_qubits]) | Snapshot instruction for statevector snapshot type |
| [`SnapshotDensityMatrix`](qiskit.providers.aer.extensions.SnapshotDensityMatrix "qiskit.providers.aer.extensions.SnapshotDensityMatrix")(label, num\_qubits) | Snapshot instruction for density matrix method of Qasm simulator. |
| [`SnapshotStabilizer`](qiskit.providers.aer.extensions.SnapshotStabilizer "qiskit.providers.aer.extensions.SnapshotStabilizer")(label\[, num\_qubits]) | Snapshot instruction for stabilizer method of Qasm simulator. |

8 changes: 4 additions & 4 deletions docs/api/qiskit/0.35/aer_jobs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This module contains classes and functions to manage Aer jobs.

The following are the classes used to manage job submissions.

| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`AerJob`](qiskit.providers.aer.jobs.AerJob#qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob")(backend, job\_id, fn, qobj\[, executor]) | AerJob class for Qiskit Aer Simulators. |
| [`AerJobSet`](qiskit.providers.aer.jobs.AerJobSet#qiskit.providers.aer.jobs.AerJobSet "qiskit.providers.aer.jobs.AerJobSet")(backend, job\_id, fn, experiments) | A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob#qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. |
| | |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob")(backend, job\_id, fn, qobj\[, executor]) | AerJob class for Qiskit Aer Simulators. |
| [`AerJobSet`](qiskit.providers.aer.jobs.AerJobSet "qiskit.providers.aer.jobs.AerJobSet")(backend, job\_id, fn, experiments) | A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. |

Loading

0 comments on commit fbaffab

Please sign in to comment.