Skip to content

Commit

Permalink
docs: add simple docs
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Feb 6, 2025
1 parent 57fb87b commit b0861df
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/execute-notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,24 @@ name = input("What is your name?")

Additional [cell tags](#tbl:notebook-cell-tags) to hide, remove, or raise exceptions are also possible.

## Skip entire notebooks

You may wish to disable execution for certain notebooks. This can be done by setting the top-level `skip_execution` frontmatter option to `true`, e.g.

````markdown
---
kernelspec:
name: python3
display_name: Python 3

skip_execution: true
---

```{code-cell}
print("This will never be executed!")
```
````

## Cache execution outputs

When MyST executes your notebook, it will store the outputs in a cache in a folder called `execute/` in your MyST build folder.
Expand Down
5 changes: 4 additions & 1 deletion docs/frontmatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,9 @@ The following table lists the available frontmatter fields, a brief description
* - `kernelspec`
- configuration for the kernel (see [](#kernel-specification))
- page only
* - `skip_execution`
- opt-out of execution for a particular document (see [](./execute-notebooks))
- page only
```
+++
Expand Down Expand Up @@ -850,4 +853,4 @@ These fields provide a more complete superset of publication metadata than the [
> Old-timey bibliographic info for this work. This is mostly useful only in citation/reference contexts. These are all strings because sometimes you'll get fun values like "Spring" and "Inside cover."
If MyST frontmatter includes an OpenAlex `biblio` object, it will be coerced to valid publication metadata.
If MyST frontmatter includes an OpenAlex `biblio` object, it will be coerced to valid publication metadata.

0 comments on commit b0861df

Please sign in to comment.