From 88d969c243673147510b53ac926ec595de41d007 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 11 Jan 2024 11:19:51 -0500 Subject: [PATCH 1/2] Rename helper to change URLs --- scripts/commands/updateApiDocs.ts | 8 ++++---- scripts/lib/api/htmlToMd.test.ts | 2 +- scripts/lib/api/htmlToMd.ts | 5 ++--- scripts/lib/api/processHtml.test.ts | 4 ++-- scripts/lib/api/processHtml.ts | 21 ++++++++++++++------- 5 files changed, 23 insertions(+), 17 deletions(-) diff --git a/scripts/commands/updateApiDocs.ts b/scripts/commands/updateApiDocs.ts index 065fb0ba5f3..f3d4134bef6 100644 --- a/scripts/commands/updateApiDocs.ts +++ b/scripts/commands/updateApiDocs.ts @@ -169,7 +169,7 @@ zxMain(async () => { await downloadCIArtifact(pkg.name, artifactUrl, destination); } - const baseSourceUrl = `https://github.com/${pkg.githubSlug}/tree/${pkg.versionWithoutPatch}/`; + const baseGitHubUrl = `https://github.com/${pkg.githubSlug}/tree/${pkg.versionWithoutPatch}/`; const outputDir = pkg.historical ? `${getRoot()}/docs/api/${pkg.name}/${pkg.versionWithoutPatch}` : `${getRoot()}/docs/api/${pkg.name}`; @@ -188,7 +188,7 @@ zxMain(async () => { await convertHtmlToMarkdown( `${destination}/artifact`, outputDir, - baseSourceUrl, + baseGitHubUrl, pkg, ); }); @@ -210,7 +210,7 @@ async function rmFilesInFolder( async function convertHtmlToMarkdown( htmlPath: string, markdownPath: string, - baseSourceUrl: string, + baseGitHubUrl: string, pkg: Pkg, ) { const files = await globby( @@ -233,7 +233,7 @@ async function convertHtmlToMarkdown( const result = await sphinxHtmlToMarkdown({ html, url: `${pkg.baseUrl}/${file}`, - baseSourceUrl, + baseGitHubUrl, imageDestination: pkg.historical ? `/images/api/${pkg.name}/${pkg.versionWithoutPatch}` : `/images/api/${pkg.name}`, diff --git a/scripts/lib/api/htmlToMd.test.ts b/scripts/lib/api/htmlToMd.test.ts index 7ef15573642..7409729160a 100644 --- a/scripts/lib/api/htmlToMd.test.ts +++ b/scripts/lib/api/htmlToMd.test.ts @@ -16,7 +16,7 @@ import { sphinxHtmlToMarkdown } from "./htmlToMd"; const DEFAULT_ARGS = { imageDestination: "/images/qiskit", - baseSourceUrl: "https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/", + baseGitHubUrl: "https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/", releaseNotesTitle: "My Quantum release notes", }; diff --git a/scripts/lib/api/htmlToMd.ts b/scripts/lib/api/htmlToMd.ts index 7106b80c003..b80360affc2 100644 --- a/scripts/lib/api/htmlToMd.ts +++ b/scripts/lib/api/htmlToMd.ts @@ -34,9 +34,8 @@ export async function sphinxHtmlToMarkdown(options: { html: string; url: string; imageDestination: string; - // url links to a fixed version and ending in / - // https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/ - baseSourceUrl: string; + // E.g. https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/ + baseGitHubUrl: string; releaseNotesTitle: string; }): Promise { const processedHtml = processHtml(options); diff --git a/scripts/lib/api/processHtml.test.ts b/scripts/lib/api/processHtml.test.ts index 51cffcd33f5..91aaccfee44 100644 --- a/scripts/lib/api/processHtml.test.ts +++ b/scripts/lib/api/processHtml.test.ts @@ -23,7 +23,7 @@ import { removeDownloadSourceCode, removePermalinks, removeColonSpans, - replaceSourceLinksWithGitHub, + replaceViewcodeLinksWithGitHub, } from "./processHtml"; import { Metadata } from "./Metadata"; @@ -245,7 +245,7 @@ test("replaceSourceLinksWithGitHub()", () => { const doc = Doc.load( ``, ); - replaceSourceLinksWithGitHub( + replaceViewcodeLinksWithGitHub( doc.$, doc.$main, "https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/", diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index b4b2a34aaec..6a514712f8d 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -28,10 +28,10 @@ export function processHtml(options: { html: string; url: string; imageDestination: string; - baseSourceUrl: string; + baseGitHubUrl: string; releaseNotesTitle: string; }): ProcessedHtml { - const { html, url, imageDestination, baseSourceUrl, releaseNotesTitle } = + const { html, url, imageDestination, baseGitHubUrl, releaseNotesTitle } = options; const $ = load(html); const $main = $(`[role='main']`); @@ -48,7 +48,7 @@ export function processHtml(options: { removeDownloadSourceCode($main); handleSphinxDesignCards($, $main); addLanguageClassToCodeBlocks($, $main); - replaceSourceLinksWithGitHub($, $main, baseSourceUrl); + replaceViewcodeLinksWithGitHub($, $main, baseGitHubUrl); convertRubricsToHeaders($, $main); processSimpleFieldLists($, $main); removeColonSpans($main); @@ -159,11 +159,18 @@ export function addLanguageClassToCodeBlocks( }); } -// TODO(#519): figure out if this is working. -export function replaceSourceLinksWithGitHub( +/** + * Redirect URLS from sphinx.ext.viewcode to instead go to GitHub. + * + * These URLs will only go to the overall source code file, not the specific lines + * of code. This function only changes the URLs; the DOM still needs to be modified + * to remove the original `[source]` anchor element from Sphinx with our own `GitHub` + * anchor element in the correct location. + */ +export function replaceViewcodeLinksWithGitHub( $: CheerioAPI, $main: Cheerio, - baseSourceUrl: string, + baseGitHubUrl: string, ): void { $main.find("a").each((_, a) => { const $a = $(a); @@ -177,7 +184,7 @@ export function replaceSourceLinksWithGitHub( } //_modules/qiskit_ibm_runtime/ibm_backend const match = href.match(/_modules\/(.*?)(#|$)/)!; - const newHref = `${baseSourceUrl}${match[1]}.py`; + const newHref = `${baseGitHubUrl}${match[1]}.py`; $a.attr("href", newHref); }); } From 606ca0f931cc98d5f8d4b138a1ddbfddfec4d8cf Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 11 Jan 2024 12:25:27 -0500 Subject: [PATCH 2/2] Add source links when using sphinx.ext.viewcode --- .../0.14/qiskit_ibm_runtime.Estimator.md | 2 +- .../0.14/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../qiskit_ibm_runtime.ParameterNamespace.md | 2 +- ...qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- .../0.14/qiskit_ibm_runtime.RuntimeProgram.md | 2 +- .../0.14/qiskit_ibm_runtime.Sampler.md | 2 +- .../0.14/qiskit_ibm_runtime.Session.md | 2 +- ..._ibm_runtime.options.EnvironmentOptions.md | 2 +- ...it_ibm_runtime.options.ExecutionOptions.md | 2 +- .../qiskit_ibm_runtime.options.Options.md | 2 +- ...t_ibm_runtime.options.ResilienceOptions.md | 2 +- ...it_ibm_runtime.options.SimulatorOptions.md | 2 +- ...bm_runtime.options.TranspilationOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.Estimator.md | 2 +- .../0.15/qiskit_ibm_runtime.IBMBackend.md | 2 +- .../qiskit_ibm_runtime.ParameterNamespace.md | 2 +- ...qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- .../0.15/qiskit_ibm_runtime.RuntimeProgram.md | 2 +- .../0.15/qiskit_ibm_runtime.Sampler.md | 2 +- .../0.15/qiskit_ibm_runtime.Session.md | 2 +- ..._ibm_runtime.options.EnvironmentOptions.md | 2 +- ...it_ibm_runtime.options.ExecutionOptions.md | 2 +- .../qiskit_ibm_runtime.options.Options.md | 2 +- ...t_ibm_runtime.options.ResilienceOptions.md | 2 +- ...it_ibm_runtime.options.SimulatorOptions.md | 2 +- ...bm_runtime.options.TranspilationOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.Estimator.md | 2 +- .../0.16/qiskit_ibm_runtime.IBMBackend.md | 2 +- ...qiskit_ibm_runtime.QiskitRuntimeService.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeDecoder.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeEncoder.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeJob.md | 2 +- .../0.16/qiskit_ibm_runtime.RuntimeOptions.md | 2 +- .../0.16/qiskit_ibm_runtime.Sampler.md | 2 +- .../0.16/qiskit_ibm_runtime.Session.md | 2 +- ..._ibm_runtime.options.EnvironmentOptions.md | 2 +- ...it_ibm_runtime.options.ExecutionOptions.md | 2 +- .../qiskit_ibm_runtime.options.Options.md | 2 +- ...t_ibm_runtime.options.ResilienceOptions.md | 2 +- ...it_ibm_runtime.options.SimulatorOptions.md | 2 +- ...bm_runtime.options.TranspilationOptions.md | 2 +- scripts/commands/updateApiDocs.ts | 2 +- scripts/lib/api/htmlToMd.test.ts | 16 +++++----- scripts/lib/api/processHtml.test.ts | 24 +++++++++++++++ scripts/lib/api/processHtml.ts | 30 ++++++++++++++----- 53 files changed, 105 insertions(+), 65 deletions(-) diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md index f006c5dff07..ef8945ab292 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md index 9474781e071..c13dc573bd8 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md index b7d9745f6ca..28e64ada419 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md index ba4ad3bbe0d..455421ceee5 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md index a9d67f28b21..811b39aa555 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md index 76df7865842..bedbe22e0cd 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md index 7b315798077..9a33ac8a6f2 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md index b970bbc1980..00432a3b753 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md index 5bcf044d9aa..c3a61a60917 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md index d0760ea6a53..25b65e83f02 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md index e066da5e766..335421e3e4c 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md index c7018b94ffc..930a5042c73 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md index 9dcb9d7a9db..1834cb65c94 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md index 1dc7fafd982..b14ff805c58 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md index e43f6e24338..d451c1e77d4 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md index 56fbf96eea6..8a4189ddeb1 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md index 8d388d9c146..17ccb3e3073 100644 --- a/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.14/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md index f006c5dff07..3585263d84d 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md index 794879ec5ad..b2675eec2da 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md index b7d9745f6ca..fc17cf68834 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.ParameterNamespace.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md index ba4ad3bbe0d..ff8facac958 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md index a9d67f28b21..dfd9ab5fa94 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md index 76df7865842..ebf4de3a805 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md index 7b315798077..c1026f2fed1 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md index b970bbc1980..58dc1a66db9 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md index 5bcf044d9aa..308e3e53776 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.RuntimeProgram.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md index d0760ea6a53..572d8f5c754 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md index 9741b8cdf9e..936913a6114 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md index c7018b94ffc..ff00beac674 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md index 9dcb9d7a9db..b178127a453 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md index 1dc7fafd982..84c686aa63a 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md index e43f6e24338..75b4d7895f6 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md index 56fbf96eea6..2f526f70b0e 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md index 8d388d9c146..706c2cedf6a 100644 --- a/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.15/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md index f006c5dff07..932c79f6d01 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Estimator.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md index 794879ec5ad..74edba64268 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md index e9cda1e1e8f..883d8f40c68 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md index a9d67f28b21..7a768189ad3 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md index 76df7865842..7d285af9edc 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: 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. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md index 7b315798077..f6fe2a4fcfc 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/runtime_job.py "view source code") Representation of a runtime program execution. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md index b970bbc1980..3699cf37c03 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/runtime_options.py "view source code") Class for representing generic runtime execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md index d0760ea6a53..f16bec7fbb7 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Sampler.md @@ -10,7 +10,7 @@ python_api_name: 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.16/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/0.16/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md index 21dd6f412a0..f6e8bf5d211 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.Session.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/session.py "view source code") Class for creating a flexible Qiskit Runtime session. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md index c7018b94ffc..54531b7523a 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/environment_options.py "view source code") Options related to the execution environment. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md index 9dcb9d7a9db..20a91324699 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/options/execution_options.py "view source code") Execution options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md index 1dc7fafd982..dd399acff6f 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)`[GitHub](https://github.com/qiskit/qiskit-ibm-runtime/tree/stable/0.16/qiskit_ibm_runtime/options/options.py "view source code") Options for the primitives. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md index e43f6e24338..9ae98a40b83 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/options/resilience_options.py "view source code") Resilience options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md index 56fbf96eea6..986b77a4b6c 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/options/simulator_options.py "view source code") Simulator options. diff --git a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md index 8d388d9c146..fb077a1b52a 100644 --- a/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/0.16/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,7 +10,7 @@ python_api_name: 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.16/qiskit_ibm_runtime/options/transpilation_options.py "view source code") Transpilation options. diff --git a/scripts/commands/updateApiDocs.ts b/scripts/commands/updateApiDocs.ts index f3d4134bef6..d46463d1dc5 100644 --- a/scripts/commands/updateApiDocs.ts +++ b/scripts/commands/updateApiDocs.ts @@ -169,7 +169,7 @@ zxMain(async () => { await downloadCIArtifact(pkg.name, artifactUrl, destination); } - const baseGitHubUrl = `https://github.com/${pkg.githubSlug}/tree/${pkg.versionWithoutPatch}/`; + const baseGitHubUrl = `https://github.com/${pkg.githubSlug}/tree/stable/${pkg.versionWithoutPatch}/`; const outputDir = pkg.historical ? `${getRoot()}/docs/api/${pkg.name}/${pkg.versionWithoutPatch}` : `${getRoot()}/docs/api/${pkg.name}`; diff --git a/scripts/lib/api/htmlToMd.test.ts b/scripts/lib/api/htmlToMd.test.ts index 7409729160a..a74c351bad2 100644 --- a/scripts/lib/api/htmlToMd.test.ts +++ b/scripts/lib/api/htmlToMd.test.ts @@ -462,7 +462,7 @@ describe("sphinxHtmlToMarkdown", () => { - \`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)\` + \`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/options/options.py "view source code") " `); }); @@ -589,7 +589,7 @@ Can be either (1) a dictionary mapping XX angle values to fidelity at that angle - \`Sampler(circuits=None, parameters=None, service=None, session=None, options=None, skip_transpilation=False)\` + \`Sampler(circuits=None, parameters=None, service=None, session=None, options=None, skip_transpilation=False) \`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/sampler.py "view source code") Class for interacting with Qiskit Runtime Sampler primitive service. ", @@ -670,7 +670,7 @@ Can be either (1) a dictionary mapping XX angle values to fidelity at that angle - \`Estimator.run(circuits, observables, parameter_values=None, **kwargs)\` + \`Estimator.run(circuits, observables, parameter_values=None, **kwargs)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_runtime/estimator.py "view source code") Submit a request to the estimator primitive program. ", @@ -763,7 +763,7 @@ By default this is sys.stdout.

- \`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)\` + \`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/job_monitor.py "view source code") Monitor the status of an \`IBMJob\` instance. @@ -815,7 +815,7 @@ By default this is sys.stdout.

- \`IBMJobError(*message)\` + \`IBMJobError(*message)\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/exceptions.py "view source code") Base class for errors raised by the job modules. @@ -886,7 +886,7 @@ By default this is sys.stdout.

- \`IBMCircuitJob.wait_for_final_state(timeout=None)\` + \`IBMCircuitJob.wait_for_final_state(timeout=None) \`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit_ibm_provider/job/ibm_circuit_job.py "view source code") ## Use the websocket server to wait for the final the state of a job. The server @@ -956,7 +956,7 @@ bits.

- \`qiskit.dagcircuit.DAGCircuit\` + \`qiskit.dagcircuit.DAGCircuit\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: \`object\` @@ -1439,7 +1439,7 @@ test("test dt tag without id", async () => { ).toMatchInlineSnapshot(` "In addition to the public abstract methods, subclasses should also implement the following private methods: - \`classmethod _default_options()\` + \`classmethod _default_options()\`[GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/0.9.2/qiskit/providers/basicaer/qasm_simulator.py "view source code") Return the default options diff --git a/scripts/lib/api/processHtml.test.ts b/scripts/lib/api/processHtml.test.ts index 91aaccfee44..9d92a450a67 100644 --- a/scripts/lib/api/processHtml.test.ts +++ b/scripts/lib/api/processHtml.test.ts @@ -24,6 +24,7 @@ import { removePermalinks, removeColonSpans, replaceViewcodeLinksWithGitHub, + prepareGitHubLink, } from "./processHtml"; import { Metadata } from "./Metadata"; @@ -298,3 +299,26 @@ describe("maybeSetModuleMetadata()", () => { ); }); }); + +describe("prepareGitHubLink()", () => { + test("no link", () => { + const html = `None)#`; + const doc = Doc.load(html); + const result = prepareGitHubLink(doc.$, doc.$main); + expect(result).toEqual(""); + doc.expectHtml(html); + }); + + test("link", () => { + const doc = Doc.load( + `None)[source]#`, + ); + const result = prepareGitHubLink(doc.$, doc.$main); + expect(result).toEqual( + `GitHub`, + ); + doc.expectHtml( + `None)#`, + ); + }); +}); diff --git a/scripts/lib/api/processHtml.ts b/scripts/lib/api/processHtml.ts index 6a514712f8d..bb85d6a3a5c 100644 --- a/scripts/lib/api/processHtml.ts +++ b/scripts/lib/api/processHtml.ts @@ -263,8 +263,8 @@ export function processMembersAndSetMeta( .toArray() .map((child) => { const $child = $(child); - $child.find(".viewcode-link").closest("a").remove(); const id = $dl.find("dt").attr("id") || ""; + const github = prepareGitHubLink($, $child); const apiType = getApiType($dl); @@ -280,7 +280,7 @@ export function processMembersAndSetMeta( if (apiType == "class") { findByText($, $main, "em.property", "class").remove(); - return `

${$child.html()}

`; + return `

${$child.html()}${github}

`; } if (apiType == "property") { @@ -291,7 +291,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "property").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature}

`; + return `

${signature}${github}

`; } if (apiType == "method") { @@ -307,7 +307,7 @@ export function processMembersAndSetMeta( } findByText($, $main, "em.property", "method").remove(); - return `

${$child.html()}

`; + return `

${$child.html()}${github}

`; } if (apiType == "attribute") { @@ -319,7 +319,7 @@ export function processMembersAndSetMeta( findByText($, $main, "em.property", "attribute").remove(); const signature = $child.find("em").text()?.replace(/^:\s+/, ""); if (signature.trim().length === 0) return; - return `

${signature}

`; + return `

${signature}${github}

`; } // Else, the attribute is embedded on the class @@ -352,12 +352,12 @@ export function processMembersAndSetMeta( if (apiType === "function") { findByText($, $main, "em.property", "function").remove(); - return `

${$child.html()}

`; + return `

${$child.html()}${github}

`; } if (apiType === "exception") { findByText($, $main, "em.property", "exception").remove(); - return `

${$child.html()}

`; + return `

${$child.html()}${github}

`; } throw new Error(`Unhandled Python type: ${apiType}`); @@ -368,6 +368,22 @@ export function processMembersAndSetMeta( } } +/** + * Removes the original link from sphinx.ext.viewcode and returns the HTML string for our own link. + * + * This returns the HTML string, rather than directly inserting into the HTML, because the insertion + * logic is most easily handled by the calling code. + */ +export function prepareGitHubLink($: CheerioAPI, $child: Cheerio): string { + const originalLink = $child.find(".viewcode-link").closest("a"); + if (originalLink.length === 0) { + return ""; + } + const href = originalLink.attr("href")!; + originalLink.remove(); + return `GitHub`; +} + export function maybeSetModuleMetadata( $: CheerioAPI, $main: Cheerio,