RFC: Re-execute notebooks on CI when building Sphinx docs #534
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.
Currently, we have set
nbsphinx_execute = "auto"
in the Sphinx configuration so that notebooks are not re-executed anytime someone runstox -e docs
, in large part to speed up the build cycle for quick development.However, even without changing this for local builds, we have the option of changing this on CI, which is where our deployed documentation is built.
Here's what would be different:
I'm not really sure which I'd prefer, but think it is worth considering merging this. Open to discussion.