-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
API generation should remove Matplotlib figure captions #732
Comments
This was referenced Jan 30, 2024
Eric-Arellano
changed the title
API generation does not handle Matplotlib figure captions
API generation should remove Matplotlib figure captions
Jan 31, 2024
github-merge-queue bot
pushed a commit
that referenced
this issue
Jan 31, 2024
The 0.17 docs are moved to be historical via `npm run make-historical -- -p qiskit-ibm-runtime`. The 0.18 docs were generated with `npm run gen-api -- -p qiskit-ibm-runtime -v 0.18.0 -a https://github.com/Qiskit/qiskit-ibm-runtime/actions/runs/7703740124/artifacts/1204347771`. Note that they include two new top-level modules, closing #238. This PR resulted in discovering #732. This has always been a problem we didn't know about. I manually ignore the broken links for now to unblock the Runtime 0.18 release and to close #238.
Eric-Arellano
modified the milestones:
24-02-13 Qiskit 1.0,
24-03-12 qiskit 1.0 release part 2
Feb 1, 2024
javabster
modified the milestones:
24-05-21 qiskit 1.0 release part 2,
runtime primitives release
Feb 16, 2024
Eric-Arellano
pushed a commit
that referenced
this issue
Feb 20, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
The 0.17 docs are moved to be historical via `npm run make-historical -- -p qiskit-ibm-runtime`. The 0.18 docs were generated with `npm run gen-api -- -p qiskit-ibm-runtime -v 0.18.0 -a https://github.com/Qiskit/qiskit-ibm-runtime/actions/runs/7703740124/artifacts/1204347771`. Note that they include two new top-level modules, closing Qiskit#238. This PR resulted in discovering Qiskit#732. This has always been a problem we didn't know about. I manually ignore the broken links for now to unblock the Runtime 0.18 release and to close Qiskit#238.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This RST results in this Sphinx-generated HTML:
Note the
Fig 1
caption and how it has 3 links to download source files for the image:This is how we render that RST in our platform after running the HTML through our pipeline:
The 3 URLs all are 404s. Instead, we should remove the caption entirely. The 3 URLs are not useful and we don't plan to support them—you can download the image directly. That would only leave the text
Fig. 1
, which we decided isn't a priority.--
This impacts the Runtime 0.18 docs in #729, along with some historical docs if you run
rg '_downloads' -l
, e.g.:documentation/docs/api/qiskit/0.42/qiskit.transpiler.passes.DynamicalDecoupling.md
Lines 69 to 75 in 75aaa31
--
Example HTML from Sphinx for a single figure:
We want to simplify the HTML via a new helper function in
processHtml.ts
. It should look like this:The function needs to use https://cheerio.js.org to remove the
<figcaption>
but if it matches this selector:figcaption span.caption-text a.download.internal.reference
. We don't want to remove any generic figcaption.We should this in
processHtml.test.ts
, including that we don't remove generic figcaptions.The final step is to run
npm run regen-apis
.The text was updated successfully, but these errors were encountered: