Skip to content

Commit

Permalink
Add source links when using sphinx.ext.viewcode (#620)
Browse files Browse the repository at this point in the history
Implements #454 for
projects that are using `sphinx.ext.viewcode`. All 3 of our projects
were historically using it until I turned it off after removing
qiskit.org, so the historical API docs are good to go. I'll restore it
for current versions of these projects and regenerate the docs.

This implementation is not a perfect implementation:

1. The visual design is a little awkward, especially the lack of
padding. This can be improved via
#518

<img width="571" alt="Screenshot 2024-01-11 at 12 28 07 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/2d915b94-ec48-445a-a174-ace628655b4b">

2. The link only takes you to the overall code page, not the specific
lines. This could be improved via
#517.

But it's good enough to not block on these improvements.

This PR regenerates all Runtime historical versions, but not any current
versions nor Qiskit historical versions.

## How source code URLs are determined

`sphinx.ext.viewcode` embeds a copy of every Python file used in API
docs and uses internal relative links like
`../modules/qiskit_ibm_runtime/ibm_backend.html`. They correspond to
Python files we can be confident exist. We transform those relative
links into GitHub links here:


https://github.com/Qiskit/documentation/blob/790e9372f64ab7d5f15eaccc229b4d0765781d44/scripts/lib/api/processHtml.ts#L94-L105


https://github.com/Qiskit/documentation/blob/790e9372f64ab7d5f15eaccc229b4d0765781d44/scripts/lib/api/processHtml.ts#L163-L183

Our links assume that there is a branch called
`stable/<versionWithoutPatch` in GitHub, like `stable/0.8`.

## Replacing `[source]` with `GitHub ↗︎`

We remove the original link from Sphinx and replace it with our own.
This is important so that the link is not included in the `<code>` HTML
element incorrectly. It also allows us to set a custom link label and
`title` (the text when highlighting).
  • Loading branch information
Eric-Arellano authored Jan 11, 2024
1 parent 76680b5 commit e37f0b9
Show file tree
Hide file tree
Showing 54 changed files with 127 additions and 81 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/estimator.py "view source code")

Class for interacting with Qiskit Runtime Estimator primitive service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/ibm_backend.py "view source code")

Backend class interfacing with an IBM Quantum backend.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace

<span id="qiskit_ibm_runtime.ParameterNamespace" />

`ParameterNamespace(parameters)`
`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code")

A namespace for program parameters with validation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code")

Class for interacting with the Qiskit Runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Decoder used by runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Encoder used by runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/runtime_job.py "view source code")

Representation of a runtime program execution.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/runtime_options.py "view source code")

Class for representing generic runtime execution options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram

<span id="qiskit_ibm_runtime.RuntimeProgram" />

`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`
`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.14/qiskit_ibm_runtime/runtime_program.py "view source code")

Class representing program metadata.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/sampler.py "view source code")

Class for interacting with Qiskit Runtime Sampler primitive service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/session.py "view source code")

Class for creating a flexible Qiskit Runtime session.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/environment_options.py "view source code")

Options related to the execution environment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/execution_options.py "view source code")

Execution options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/options.py "view source code")

Options for the primitives.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/resilience_options.py "view source code")

Resilience options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/simulator_options.py "view source code")

Simulator options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.14/qiskit_ibm_runtime/options/transpilation_options.py "view source code")

Transpilation options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/estimator.py "view source code")

Class for interacting with Qiskit Runtime Estimator primitive service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/ibm_backend.py "view source code")

Backend class interfacing with an IBM Quantum backend.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.ParameterNamespace

<span id="qiskit_ibm_runtime.ParameterNamespace" />

`ParameterNamespace(parameters)`
`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code")

A namespace for program parameters with validation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code")

Class for interacting with the Qiskit Runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Decoder used by runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Encoder used by runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/runtime_job.py "view source code")

Representation of a runtime program execution.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/runtime_options.py "view source code")

Class for representing generic runtime execution options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeProgram

<span id="qiskit_ibm_runtime.RuntimeProgram" />

`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`
`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.15/qiskit_ibm_runtime/runtime_program.py "view source code")

Class representing program metadata.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/sampler.py "view source code")

Class for interacting with Qiskit Runtime Sampler primitive service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/session.py "view source code")

Class for creating a flexible Qiskit Runtime session.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/environment_options.py "view source code")

Options related to the execution environment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/execution_options.py "view source code")

Execution options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/options.py "view source code")

Options for the primitives.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/resilience_options.py "view source code")

Resilience options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/simulator_options.py "view source code")

Simulator options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.15/qiskit_ibm_runtime/options/transpilation_options.py "view source code")

Transpilation options.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.16/qiskit_ibm_runtime/estimator.py "view source code")

Class for interacting with Qiskit Runtime Estimator primitive service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.16/qiskit_ibm_runtime/ibm_backend.py "view source code")

Backend class interfacing with an IBM Quantum backend.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.16/qiskit_ibm_runtime/qiskit_runtime_service.py "view source code")

Class for interacting with the Qiskit Runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.16/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Decoder used by runtime service.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.16/qiskit_ibm_runtime/utils/json.py "view source code")

JSON Encoder used by runtime service.

Expand Down
Loading

0 comments on commit e37f0b9

Please sign in to comment.