From cf87205a3a2ac9bd46b8fcaa260beaddf5cff345 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 28 Feb 2024 15:18:32 +0100 Subject: [PATCH] add clarifiation on keep-output --- book/features/live_code.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/book/features/live_code.md b/book/features/live_code.md index faa384a..625414c 100644 --- a/book/features/live_code.md +++ b/book/features/live_code.md @@ -43,9 +43,9 @@ If you push to main, you can test the interactivity on the book-draft website as ## Custom cell tags With the extended functionality of live code, additional cell tags have been developed to be added to cells in any .ipynb file, next to the [existing tags] of the jupyter book (https://jupyterbook.org/en/stable/content/metadata.html): - `disable-execution-cell` disables the ability to execute the cell when thebe is activated. This might be useful if you notebook file includes interactivity for only a part of the coding cells -- `disable-execution-page` disable the ability to execute the entire page. This might be useful if you use python code for creating a page, but the code is not part of the actual content of the book. -- `auto-execute-page`, automatically starts the thebe live coding functionality whenever the page is opened. This is particularly useful if you're using widgets on a page. At this moment, this tags doesn't work in combination with `thebe-remove-input-init` -- `thebe-init`, directly starts running this cell as soon as the thebe live coding functionality starts. -- `thebe-remove-input-init`, as `thebe-init` the cell is started directly as soon as the thebe live coding functionality starts. However, the input is not shown to the students (in static and interactive mode). The original `remove-input` tag will not work as it deletes the entire cell, so it can never be executed. -- `keep-output` ...? Max? +- `disable-execution-page` disables the ability to execute the entire page. This might be useful if you use python code for creating a page, but the code is not part of the actual content of the book. +- `auto-execute-page` automatically starts the thebe live coding functionality whenever the page is opened. This is particularly useful if you're using widgets on a page. At this moment, this tags doesn't work in combination with `thebe-remove-input-init` +- `thebe-init` directly starts running this cell as soon as the thebe live coding functionality starts. +- `thebe-remove-input-init`, as `thebe-init`, starts the cell directly as soon as the thebe live coding functionality starts. However, the input is not shown to the students (in static and interactive mode). The original `remove-input` tag will not work as it deletes the entire cell, so it can never be executed. +- `keep-output` keep the pre-existing output of a cell of which the input is hidden using `remove-input`.