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

Speed up dev build of docs #10624

Merged
merged 4 commits into from
Aug 15, 2023
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

@Eric-Arellano Eric-Arellano commented Aug 14, 2023

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).

@Eric-Arellano Eric-Arellano requested a review from a team as a code owner August 14, 2023 18:27
@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:

@CLAassistant
Copy link

CLAassistant commented Aug 14, 2023

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


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.

@coveralls
Copy link

coveralls commented Aug 14, 2023

Pull Request Test Coverage Report for Build 5860751626

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 19 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.01%) to 87.242%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 1 90.89%
crates/qasm2/src/parse.rs 18 96.67%
Totals Coverage Status
Change from base Build 5860553430: -0.01%
Covered Lines: 74282
Relevant Lines: 85145

💛 - Coveralls

Copy link
Member

@mtreinish mtreinish left a 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..

Comment on lines -82 to +83
run: tox -e gettext
run: tox run -e gettext
Copy link
Collaborator Author

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.

Copy link
Member

@mtreinish mtreinish left a 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.

@mtreinish mtreinish added this pull request to the merge queue Aug 15, 2023
@Eric-Arellano Eric-Arellano added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Aug 15, 2023
Merged via the queue into Qiskit:main with commit 61a3a43 Aug 15, 2023
14 checks passed
@Eric-Arellano Eric-Arellano deleted the speed-up-dev-docs branch August 15, 2023 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants