feat: freezing/caching of outputs#158
Merged
Merged
Conversation
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.
This PR introduces support for freezing, which enables caching of executed code cell outputs to speed up documentation builds by avoiding redundant computation. It adds the
great-docs freezeCLI command for managing the freeze cache. The new command lets you execute, cache, and manage freeze outputs for documentation pages, including options for cleaning, info/status reporting, and custom cache directories. This includes logic to detect which pages are frozen, check cache status, and copy/merge freeze outputs.A new User Guide page is added ("Freeze & Caching") that explains the new feature in detail. A live demonstration recipe page ("Freeze a Page to Cache Outputs") shows the effect of the freeze (cached timestamp and system information).
The feature will be marked as Experimental for some time. Additional testing will be added in upcoming PRs and there may also be some minor API additions around this new feature.
Fixes: #155