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

docs: optimise building with html-tutorial support #1146

Merged
merged 2 commits into from
Oct 9, 2024
Merged

Conversation

bjlittle
Copy link
Owner

@bjlittle bjlittle commented Oct 9, 2024

🚀 Pull Request

Description

Been meaning to do this for a while now ...

This pull-request optimises documentation building by adding an option to control whether the tutorial jupyter notebook code cells are executed. Not executing notebook cells can make a significant saving at build time, as typically our notebooks will be rich in image rendering, and as we add more content this will become more expensive.

This is a welcome optimisation, particularly when using the make html-noplot workflow e.g., building the docs to eyeball a pull-request changelog contribution should be a slick experience for a fast contributor turnaround.

Note that, we now have the following behaviours:

Command Doc-string Images Gallery Images Tutorial Images
make doctest
make html ☑️ ☑️ ☑️
make html-docstring ☑️
make html-gallery ☑️
make html-noplot
make html-tutorial (†) ☑️
make linkcheck

† - This is a new Makefile build command.


@github-actions github-actions bot added the type: documentation Auto-labelled for doc/* and docs/* branches label Oct 9, 2024
Copy link

codecov bot commented Oct 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.28%. Comparing base (6e26f58) to head (6620ebe).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1146   +/-   ##
=======================================
  Coverage   91.28%   91.28%           
=======================================
  Files          58       58           
  Lines        2939     2939           
=======================================
  Hits         2683     2683           
  Misses        256      256           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bjlittle bjlittle force-pushed the docs-make-tutorial branch from dc66903 to 6620ebe Compare October 9, 2024 22:33
@bjlittle bjlittle merged commit 5bcb292 into main Oct 9, 2024
21 checks passed
@bjlittle bjlittle deleted the docs-make-tutorial branch October 9, 2024 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Auto-labelled for doc/* and docs/* branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant