docs: optimise building with html-tutorial support #1146
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 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:
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.