Skip to content
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

remove matplotlib figure captions #848

Merged
merged 10 commits into from
Feb 20, 2024
Merged

Conversation

kevinsung
Copy link
Collaborator

Fixes #732

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huzzah! After making the requested changes, you'll need to run npm run regen-apis. This takes ~40 minutes and means you can't make changes to the repo because it messes up your Git state, so I recommend doing it during meetings. It runs in the background. Or let me know if you want me to run it for you.

scripts/lib/api/processHtml.test.ts Outdated Show resolved Hide resolved
scripts/lib/api/processHtml.ts Show resolved Hide resolved
@kevinsung
Copy link
Collaborator Author

@Eric-Arellano I've run npm run regen-apis

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kevinsung
Copy link
Collaborator Author

Apparently that introduced some broken links. Do you know how to fix it?

@Eric-Arellano
Copy link
Collaborator

Oops, I introduced them in #850. Our link checker didn't run like it should have. I'll fix.

@Eric-Arellano Eric-Arellano merged commit df0018e into main Feb 20, 2024
5 of 6 checks passed
@Eric-Arellano Eric-Arellano deleted the kjs/remove-matplotlib-figs branch February 20, 2024 18:48
github-merge-queue bot pushed a commit that referenced this pull request Feb 21, 2024
The API checks didn't run in
#850 because our GitHub
Action didn't include `public/api` in its globs. So, we accidentally
broke the link checker.

This PR adds the new mechanism of `IGNORED_FILES`. The `objects.inv` has
way too many errors in 0.14 - 0.16 to be worth trying to fix or
blocklist specific failures.

Finally, it removes ignores that are now stale thanks to
#848.
Eric-Arellano added a commit that referenced this pull request Feb 21, 2024
Follow up to #848. Sphinx
used to use a different HTML structure we weren't accounting for.

After this PR, there are no more bad URLs:

```
❯ rg '_downloads' -l
scripts/lib/api/htmlToMd.test.ts
scripts/lib/links/ignores.ts
scripts/lib/api/processHtml.test.ts
```
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
The API checks didn't run in
Qiskit#850 because our GitHub
Action didn't include `public/api` in its globs. So, we accidentally
broke the link checker.

This PR adds the new mechanism of `IGNORED_FILES`. The `objects.inv` has
way too many errors in 0.14 - 0.16 to be worth trying to fix or
blocklist specific failures.

Finally, it removes ignores that are now stale thanks to
Qiskit#848.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Follow up to Qiskit#848. Sphinx
used to use a different HTML structure we weren't accounting for.

After this PR, there are no more bad URLs:

```
❯ rg '_downloads' -l
scripts/lib/api/htmlToMd.test.ts
scripts/lib/links/ignores.ts
scripts/lib/api/processHtml.test.ts
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

API generation should remove Matplotlib figure captions
2 participants