scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit-ibm-runtime/0.37
History
Arnau Casau f09e7fb055
Add `/docs/` base path to all API docs links (#2973) 
This PR adds the `/docs/` base path to all API docs links by modifying
the MDX conversion pipeline. It also updates all the ignores to include
the base path.

I recommend reviewing the first 5 commits separately as they implement
all the code changes. The rest of the commits have been generated by
running `npm run regen-apis`

To update the qiskit release notes I used the following script:

<details><summary>Script</summary>

```ts
import { globby } from "globby";
import { readFile, writeFile } from "fs/promises";

export async function updateBrokenLinks(filePath: string): Promise<void> {
  let markdown = (await readFile(filePath)).toString();

  var regex = new RegExp(`\\]\\(\\/((?!docs\\/)[^\\)]*)\\)`, "g");
  markdown = markdown.replaceAll(regex, `\]\(/docs/$1\)`);

  await writeFile(filePath, markdown);
}

async function main() {
  const globs = [
    "docs/api/qiskit/release-notes/**/*.{ipynb,mdx}",
  ];
  const allGuides = await globby(globs);
  for (const guide of allGuides) {
    await updateBrokenLinks(guide);
  }
}

main().then(() => process.exit());
```

</details>

The PR workarounds some checks in order to get green CI. All of the
checks will be updated to take into account the base path in
https://github.com/Qiskit/documentation/pull/2958
 		2025-04-17 14:59:41 +00:00
..
_package.json Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
_toc.json Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
batch.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
debug-tools-neat-pub-result.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
debug-tools-neat-result.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
debug-tools-neat.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
debug-tools.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
estimator-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
estimator.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-double-slice-span.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-execution-span.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-execution-spans.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-shape-type.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-slice-span.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span-twirled-slice-span.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
execution-span.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
fake-provider-fake-algiers.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-almaden-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-armonk-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-athens-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-auckland.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-belem-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-boeblingen-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-bogota-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-brisbane.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-brooklyn-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-burlington-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-cairo-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-cambridge-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-casablanca-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-cusco.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-essex-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-fez.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-fractional-backend.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-geneva.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-guadalupe-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-hanoi-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-jakarta-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-johannesburg-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-kawasaki.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-kolkata-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-kyiv.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-kyoto.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-lagos-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-lima-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-london-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-manhattan-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-manila-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-marrakesh.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-melbourne-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-montreal-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-mumbai-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-nairobi-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-osaka.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-oslo.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-ourense-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-paris-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-peekskill.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-perth.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-poughkeepsie-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-prague.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-provider-for-backend-v2.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
fake-provider-fake-quebec.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-quito-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-rochester-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-rome-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-santiago-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-sherbrooke.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-singapore-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-sydney-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-torino.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-toronto-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-valencia-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-vigo-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-washington-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider-fake-yorktown-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
fake-provider.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
ibm-backend.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
index.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
noise-learner-noise-learner.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
noise-learner-result.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
noise-learner.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-dynamical-decoupling-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-environment-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-estimator-options.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
options-execution-options-v2.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-layer-noise-learning-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-measure-noise-learning-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-noise-learner-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-pec-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-resilience-options-v2.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-sampler-execution-options-v2.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-sampler-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options-simulator-options.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
options-twirling-options.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
options-zne-options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
options.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
qiskit-runtime-service.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
runtime-decoder.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
runtime-encoder.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
runtime-job-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
runtime-job.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
runtime-service.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
sampler-v2.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
sampler.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
session.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-convert-id-to-delay.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-convert-isa-to-clifford.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-alap-schedule-analysis.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-asap-schedule-analysis.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-block-base-padder.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-dynamic-circuit-instruction-durations.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-pad-delay.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling-pad-dynamical-decoupling.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler-passes-scheduling.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
transpiler.mdx Add `/docs/` base path to all API docs links (#2973) 2025-04-17 14:59:41 +00:00
utils-noise-learner-result-layer-error.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
utils-noise-learner-result-pauli-lindblad-error.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization-draw-execution-spans.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization-draw-layer-error-map.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization-draw-layer-errors-swarm.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization-draw-zne-evs.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization-draw-zne-extrapolators.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00
visualization.mdx Generate runtime 0.38.0 (#3008) 2025-04-17 13:39:07 +00:00