Generate current Qiskit and Runtime API docs with GitHub source links (…

…#632) This also brings in some small updates to the Qiskit API docs which go from 0.45.0 to 0.45.1. ``` npm run gen-api -- -p qiskit -v 0.45.1 -a https://github.com/Qiskit/qiskit/actions/runs/7544113590/artifacts/1172709416 npm run gen-api -- -p qiskit-ibm-runtime -v 0.17.0 -a https://github.com/Qiskit/qiskit-ibm-runtime/actions/runs/7504804240/artifacts/1165774594 ``` The second commit adds special casing for 3 Qiskit modules.
Qiskit · Jan 16, 2024 · eda8200 · eda8200
1 parent 33d5214
commit eda8200
Show file tree

Hide file tree

Showing 931 changed files with 2,451 additions and 2,192 deletions.
diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Estimator
 
 <span id="qiskit_ibm_runtime.Estimator" />
 
-`Estimator(backend=None, session=None, options=None)`
+`Estimator(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/estimator.py "view source code")
 
 Class for interacting with Qiskit Runtime Estimator primitive service.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
 <span id="qiskit_ibm_runtime.IBMBackend" />
 
-`IBMBackend(configuration, service, api_client, instance=None)`
+`IBMBackend(configuration, service, api_client, instance=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/ibm_backend.py "view source code")
 
 Backend class interfacing with an IBM Quantum backend.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
 
 <span id="qiskit_ibm_runtime.QiskitRuntimeService" />
 
-`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`
+`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code")
 
 Class for interacting with the Qiskit Runtime service.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
 
 <span id="qiskit_ibm_runtime.RuntimeDecoder" />
 
-`RuntimeDecoder(*args, **kwargs)`
+`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code")
 
 JSON Decoder used by runtime service.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
 
 <span id="qiskit_ibm_runtime.RuntimeEncoder" />
 
-`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`
+`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/utils/json.py "view source code")
 
 JSON Encoder used by runtime service.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
 
 <span id="qiskit_ibm_runtime.RuntimeJob" />
 
-`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`
+`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_job.py "view source code")
 
 Representation of a runtime program execution.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions
 
 <span id="qiskit_ibm_runtime.RuntimeOptions" />
 
-`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`
+`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/runtime_options.py "view source code")
 
 Class for representing generic runtime execution options.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Sampler
 
 <span id="qiskit_ibm_runtime.Sampler" />
 
-`Sampler(backend=None, session=None, options=None)`
+`Sampler(backend=None, session=None, options=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/sampler.py "view source code")
 
 Class for interacting with Qiskit Runtime Sampler primitive service.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.Session
 
 <span id="qiskit_ibm_runtime.Session" />
 
-`Session(service=None, backend=None, max_time=None)`
+`Session(service=None, backend=None, max_time=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/session.py "view source code")
 
 Class for creating a flexible Qiskit Runtime session.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions
 
 <span id="qiskit_ibm_runtime.options.EnvironmentOptions" />
 
-`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=<factory>)`
+`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=<factory>)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/environment_options.py "view source code")
 
 Options related to the execution environment.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions
 
 <span id="qiskit_ibm_runtime.options.ExecutionOptions" />
 
-`ExecutionOptions(shots=4000, init_qubits=True)`
+`ExecutionOptions(shots=4000, init_qubits=True)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/execution_options.py "view source code")
 
 Execution options.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options
 
 <span id="qiskit_ibm_runtime.options.Options" />
 
-`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=<factory>, resilience=<factory>, execution=<factory>, environment=<factory>, simulator=<factory>)`
+`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=<factory>, resilience=<factory>, execution=<factory>, environment=<factory>, simulator=<factory>)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/options.py "view source code")
 
 Options for the primitives.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions
 
 <span id="qiskit_ibm_runtime.options.ResilienceOptions" />
 
-`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`
+`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/resilience_options.py "view source code")
 
 Resilience options.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions
 
 <span id="qiskit_ibm_runtime.options.SimulatorOptions" />
 
-`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`
+`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/simulator_options.py "view source code")
 
 Simulator options.
 

diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions
 
 <span id="qiskit_ibm_runtime.options.TranspilationOptions" />
 
-`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`
+`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.17/qiskit_ibm_runtime/options/transpilation_options.py "view source code")
 
 Transpilation options.
 

diff --git a/docs/api/qiskit/_package.json b/docs/api/qiskit/_package.json
@@ -1,4 +1,4 @@
 {
   "name": "qiskit",
-  "version": "0.45.0"
+  "version": "0.45.1"
 }
diff --git a/docs/api/qiskit/algorithms.md b/docs/api/qiskit/algorithms.md
@@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states.
 
 <span id="qiskit.algorithms.AlgorithmError" />
 
-`qiskit.algorithms.AlgorithmError(*message)`
+`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/exceptions.py "view source code")
 
 For Algorithm specific errors.
 
@@ -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)`
+`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")
 
 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.
 
@@ -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)`
+`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")
 
 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.
 

diff --git a/docs/api/qiskit/assembler.md b/docs/api/qiskit/assembler.md
@@ -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)`
+`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")
 
 Assembles a list of circuits into a qobj that can be run on the backend.
 
@@ -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)`
+`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")
 
 Assembles a list of schedules into a qobj that can be run on the backend.
 
@@ -129,7 +129,7 @@ pulseQobj = assemble_schedules(schedules=[schedule],
 
 <span id="qiskit.assembler.disassemble" />
 
-`qiskit.assembler.disassemble(qobj)`
+`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code")
 
 Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header.
 
@@ -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. |