Skip to content

Commit

Permalink
Revert Qiskit API docs generation (#635)
Browse files Browse the repository at this point in the history
There are some pages that fail to render due to Katex (math equations).
It blocked us from deploying the docs. So we'll want to regenerate the
Qiskit docs later once that's figured out. For now, unblock the deploy.
  • Loading branch information
Eric-Arellano committed Jan 16, 2024
1 parent eda8200 commit f91725e
Show file tree
Hide file tree
Showing 914 changed files with 2,177 additions and 2,424 deletions.
2 changes: 1 addition & 1 deletion docs/api/qiskit/_package.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"name": "qiskit",
"version": "0.45.1"
"version": "0.45.0"
}
8 changes: 4 additions & 4 deletions docs/api/qiskit/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states.

<span id="qiskit.algorithms.AlgorithmError" />

`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/exceptions.py "view source code")
`qiskit.algorithms.AlgorithmError(*message)`

For Algorithm specific errors.

Expand All @@ -207,15 +207,15 @@ Utility classes used by algorithms (mainly for type-hinting purposes).

| | |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| [`AlgorithmJob`](qiskit.algorithms.AlgorithmJob "qiskit.algorithms.AlgorithmJob")(function, \*args, \*\*kwargs) | This empty class is introduced for typing purposes. |
| [`AlgorithmJob`](qiskit.algorithms.AlgorithmJob "qiskit.algorithms.AlgorithmJob")(function, \*args, \*\*kwargs) | This empty class is introduced for typing purposes. |

### Utility functions

Utility functions used by algorithms.

<span id="qiskit.algorithms.eval_observables" />

`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/aux_ops_evaluator.py "view source code")
`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`

Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold.

Expand Down Expand Up @@ -247,7 +247,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P

<span id="qiskit.algorithms.estimate_observables" />

`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/observables_evaluator.py "view source code")
`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`

Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold.

Expand Down
8 changes: 4 additions & 4 deletions docs/api/qiskit/assembler.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ python_api_name: qiskit.assembler

<span id="qiskit.assembler.assemble_circuits" />

`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_circuits.py "view source code")
`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`

Assembles a list of circuits into a qobj that can be run on the backend.

Expand Down Expand Up @@ -65,7 +65,7 @@ qobj = assemble_circuits(circuits=[qc],

<span id="qiskit.assembler.assemble_schedules" />

`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_schedules.py "view source code")
`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`

Assembles a list of schedules into a qobj that can be run on the backend.

Expand Down Expand Up @@ -129,7 +129,7 @@ pulseQobj = assemble_schedules(schedules=[schedule],

<span id="qiskit.assembler.disassemble" />

`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code")
`qiskit.assembler.disassemble(qobj)`

Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header.

Expand Down Expand Up @@ -176,5 +176,5 @@ circuits, run_config_out, headers = disassemble(qobj)

| | |
| -------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, seed\_simulator, memory, ...]) | Class for Run Configuration. |
| [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, seed\_simulator, memory, ...]) | Class for Run Configuration. |

Loading

0 comments on commit f91725e

Please sign in to comment.