Speed up dev build of docs#10624
Conversation
|
One or more of the the following people are requested to review this:
|
|
Eric Arellano seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Pull Request Test Coverage Report for Build 5860751626
💛 - Coveralls |
01db047 to
2def486
Compare
mtreinish
left a comment
There was a problem hiding this comment.
This LGTM, I also took a look at the dev docs build locally from the ci artifacts and it seems like a reasonable tradeoff for speed vs a "complete" build. The lack of the full toctree for the sidebar and the viewcode extension don't impact the test coverage of docs builds in a meaningful way. I think the only thing missing now is to just update this to address the merge conflicts and also update the new deploy jobs to set DOCS_PROD_BUILD so we're building the full docs for publishing..
| run: tox -e gettext | ||
| run: tox run -e gettext |
There was a problem hiding this comment.
Doesn't matter much, but to be consistent with rest of the file.
mtreinish
left a comment
There was a problem hiding this comment.
LGTM, thanks for the quick update.
The Furo docs theme we now use is naively slower than our old Pytorch theme (Qiskit/qiskit_sphinx_theme#328): the docs build wall-time goes from 13.75 minutes to 40 minutes.
So, this PR distinguishes between prod builds vs. dev/CI builds. CI builds only take 15 minutes, a 1.25 minute slowdown from Pytorch. The slowdown comes from viewcode (14 minutes) and including the API docs in the left sidebar (11 minutes).