Check Runtime historical API docs for broken links #569
Conversation
57f704d to
faf21ae
Compare
.github/workflows/main.yml
Outdated
| --historical-apis \ | ||
| --skip-broken-historical |
There was a problem hiding this comment.
This will make CI for every PR a little slower. But given that we're making changes to the API generation script the next two months, it's probably worth it. We could always remove it if CI is getting too slow.
There was a problem hiding this comment.
Awesome! Good thinking adding this new argument! I tested it locally, and it works very well. It's true that checking the historical APIs will make the CI slower, but I suspect that once we regenerate the docs with #552 applied, the time will be reduced a lot too.
Testing the regeneration of qiskit v0.24, we reduced the number of broken links from 17795 to 146, and not only because they are fixed but because we have much fewer links too. I have to verify that we don't have any issues with the regeneration, but it seems promising 😃
Part of #495. We now will enforce in CI that historical API docs are valid for Runtime and Provider. To do this, this PR adds the `--skip-broken-historical` argument. In a follow up, I want to try checking Qiskit docs, at least certain versions. But I'm waiting until we regenerate the docs with #552 applied because I suspect it will fix some issues.
Part of Qiskit#495. We now will enforce in CI that historical API docs are valid for Runtime and Provider. To do this, this PR adds the `--skip-broken-historical` argument. In a follow up, I want to try checking Qiskit docs, at least certain versions. But I'm waiting until we regenerate the docs with Qiskit#552 applied because I suspect it will fix some issues.
As of Qiskit#569 and Qiskit#572, our extended check PR now checks more than simply external links. It also checks: * that all pages render for translations and API docs * the internal links for API docs So, we should run these extended checks when we make changes to the API and translations folders.
Part of #495. We now will enforce in CI that historical API docs are valid for Runtime and Provider. To do this, this PR adds the
--skip-broken-historicalargument.In a follow up, I want to try checking Qiskit docs, at least certain versions. But I'm waiting until we regenerate the docs with #552 applied because I suspect it will fix some issues.