Exclude jupyter_execute output from documentation build#122
Merged
Conversation
myst-nb writes executed notebooks into a jupyter_execute directory inside the source tree. With the source root at the project root, each rebuild re-read that output as source and nested it deeper (jupyter_execute/.../jupyter_execute/...), eventually failing with a missing .doctree path. Exclude jupyter_execute at any depth so it is never picked up as source. Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Contributor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage 83.72% 83.72%
=======================================
Files 10 10
Lines 1456 1456
Branches 150 150
=======================================
Hits 1219 1219
Misses 198 198
Partials 39 39 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
myst-nb writes executed notebooks into a
jupyter_executedirectory inside the source tree. Because yardang builds with the source root at the project root andjupyter_executewas not excluded, each rebuild re-read that output as source and nested it deeper:Eventually the build fails with a missing doctree, e.g.:
This adds
jupyter_execute(at any depth) toexclude_patternsso Sphinx never picks the executed-notebook output back up as source.Verification
Checked with Sphinx's own
sphinx.util.matching.Matcher:docs/jupyter_execute/...and arbitrarily-nested.../jupyter_execute/.../jupyter_execute/...docs/notebooks/exampleanddocs/src/configurationNote for existing checkouts: delete any already-nested output before rebuilding —
rm -rf docs/jupyter_execute docs/html(both gitignored).