Add Sphinx-Gallery caching and stabilize CI cache keys#23
Merged
bruAristimunha merged 1 commit intomainfrom Mar 22, 2026
Merged
Add Sphinx-Gallery caching and stabilize CI cache keys#23bruAristimunha merged 1 commit intomainfrom
bruAristimunha merged 1 commit intomainfrom
Conversation
- Add gallery output caching in docs.yml keyed by examples/**/*.py hash, so unchanged examples are not re-executed on subsequent builds - Replace github.run_id with stable v1 suffix in data cache keys across both docs.yml and install-tests.yml to avoid unnecessary cache churn (downloaded datasets don't change between runs)
📚 Documentation Preview📦 Download Documentation Artifact
💡 To enable live previews, add a |
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.
Summary
docs.ymlkeyed byhashFiles('examples/**/*.py'), so unchanged examples skip re-execution on subsequent buildsdocs.ymlandinstall-tests.ymlby replacinggithub.run_idwith a fixedv1suffix — downloaded datasets (MNE, Nilearn) don't change between runs, so therun_id-based key was creating unnecessary cache entriesContext
Current docs build on main takes ~23 min. PR #21 adds a heavy example (
plot_liebn_batch_normalization.py) that causes builds to hang for 6+ hours. This PR provides caching infrastructure so that once examples are built, they won't re-run unless the example scripts change.Test plan