From 7536dd647b6a1f922eb9421f8f5747840d0bc824 Mon Sep 17 00:00:00 2001 From: Angus Hollands Date: Tue, 23 Jan 2024 18:55:24 +0000 Subject: [PATCH] docs: update README --- packages/myst-execute/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/myst-execute/README.md b/packages/myst-execute/README.md index d3b8d29f8..d9962e5fb 100644 --- a/packages/myst-execute/README.md +++ b/packages/myst-execute/README.md @@ -1,3 +1,5 @@ # MyST Execute -This library executes MyST content with Jupyter. It provides a transform that take a MyST tree and fills output nodes. It also provides caching for accessing code block outputs by ID. +Kernel execution of code and inline expressions using Jupyter. + +This package provides a transform that takes a MyST tree, computes the executable content, and stores the results in the AST. It provides basic support for caching of outputs to avoid needless computation.