-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Speed up dev build of docs #10624
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't matter much, but to be consistent with rest of the file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).