-
-
Notifications
You must be signed in to change notification settings - Fork 166
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
Distribute docs build over number of CPUs. #2235
base: main
Are you sure you want to change the base?
Conversation
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.
Hello @cosenal, thank you for submitting a PR to Mitiq! We will respond as soon as possible, and if you have any questions in the meantime, you can ask us on the Unitary Fund Discord.
Nice! It's failing here, not sure why. |
@nathanshammah Yes, I cancelled the workflow, because I saw it failing on the docs build, which I am investigating. I am leaving it as a Draft PR until the build is fixed. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2235 +/- ##
=======================================
Coverage 98.72% 98.72%
=======================================
Files 92 92
Lines 4161 4161
=======================================
Hits 4108 4108
Misses 53 53 ☔ View full report in Codecov by Sentry. |
Is this blocked by the PyData Sphinx theme action? |
@nathanshammah indeed – I have just dropped a comment there |
Since v0.15.4, the Sphinx theme enabled parallel write. The next blocking factor is Jupyter-cache not supporting parallel execution, see executablebooks/jupyter-cache#37 and sphinx-doc/sphinx#12481. |
c92ca46
to
8b5530d
Compare
Description
An attempt to speed up docs build (related to #2083, but not the same as that's about RTD).
It looks like the bottleneck is the notebook execution. MyST-NB is parallel-friendly, hence this attempt.
Some data points from testing this on my local machine (Apple M2 Pro):
time make docs-clean
License
Before opening the PR, please ensure you have completed the following where appropriate.
N/A - [ ] I added unit tests for new code.
N/A - [ ] I used type hints in function signatures.
N/A - [ ] I used Google-style docstrings for functions.
N/A - [ ] I updated the documentation where relevant.