diff --git a/content/conf.py b/content/conf.py index a33793b..26206f0 100644 --- a/content/conf.py +++ b/content/conf.py @@ -43,7 +43,12 @@ # jupyter_execute_notebooks = "off" # jupyter_execute_notebooks = "auto" # *only* execute if at least one output is missing. # jupyter_execute_notebooks = "force" -jupyter_execute_notebooks = "cache" +nb_execution_mode = "cache" + +# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html +myst_enable_extensions = [ + "colon_fence", +] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] diff --git a/content/guide.md b/content/guide.md new file mode 100644 index 0000000..1bca7e0 --- /dev/null +++ b/content/guide.md @@ -0,0 +1,17 @@ +# Instructor's guide + +## Why we teach this lesson + +## Intended learning outcomes + +## Timing + +## Preparing exercises + +e.g. what to do the day before to set up common repositories. + +## Other practical aspects + +## Interesting questions you might get + +## Typical pitfalls diff --git a/content/guide.rst b/content/guide.rst-if-wanted similarity index 100% rename from content/guide.rst rename to content/guide.rst-if-wanted diff --git a/content/index.md b/content/index.md new file mode 100644 index 0000000..ac790c9 --- /dev/null +++ b/content/index.md @@ -0,0 +1,37 @@ +# LESSON NAME + +Intro + +:::{prereq} +prerequisites +::: + +```{csv-table} +:delim: ; +:widths: auto + +20 min ; :doc:`filename` +``` + +```{toctree} +:caption: The lesson +:maxdepth: 1 +``` + +```{toctree} +:caption: Reference +:maxdepth: 1 + +quick-reference +guide +``` + +(learner-personas)= + +## Who is the course for? + +## About the course + +## See also + +## Credits diff --git a/content/index.rst b/content/index.rst-if-wanted similarity index 100% rename from content/index.rst rename to content/index.rst-if-wanted diff --git a/content/quick-reference.md b/content/quick-reference.md new file mode 100644 index 0000000..fa95ef1 --- /dev/null +++ b/content/quick-reference.md @@ -0,0 +1 @@ +# Quick Reference diff --git a/content/quick-reference.rst b/content/quick-reference.rst-if-wanted similarity index 100% rename from content/quick-reference.rst rename to content/quick-reference.rst-if-wanted