f09e7fb055
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
|
||
|---|---|---|
| .. | ||
| _package.json | ||
| _toc.json | ||
| coloring.mdx | ||
| index.mdx | ||
| problem-generators.mdx | ||
| release-notes.mdx | ||
| slicing-transpiler-passes-collect-op-color.mdx | ||
| slicing-transpiler-passes-collect-op-size.mdx | ||
| slicing-transpiler-passes-collect-op-type.mdx | ||
| slicing-transpiler-passes.mdx | ||
| slicing.mdx | ||