Repository navigation
Add an opt-in export of downloads to a stable folder tree - #61
Merged
Merged
Conversation
Each gallery download is also written to <export_dir>/<format>/<docname folder>/<file>, so a site can publish them (e.g. to MyBinder) without the digest folders.
Downloads land at <export_dir>/<source>/<format>/<page folder>/<file>. export_sources defaults to ['gallery'].
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #61 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 3 3
Lines 1747 1784 +37
Branches 335 341 +6
=======================================
+ Hits 1746 1783 +37
Partials 1 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…rces Adds _SOURCE_GALLERY, _SOURCE_DOCSTRINGS and _SOURCE_ORDER beside the format names, replaces a test that could not fail, and states in the README which downloads are exported and when.
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
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.
Adds an opt-in copy of the generated downloads into a stable folder tree, so a site can publish them without the
_downloads/<digest>/folders. Needed for pyvista/pyvista#9533, where MyBinder takes the gallery notebooks by section.export_dirkey (defaultNone): each download is also copied to<export_dir>/<source>/<format>/<page folder>/<file>, e.g.gallery/jupyter/examples/04-lights/shadows.ipynb. A relative path resolves from theconf.pyfolder.export_sourceskey (default['gallery']): any of'gallery'and'docstrings', also accepted as a comma-separated-Dvalue.🤖 Generated with Claude Code (Claude Opus 5.5)