Merge remote-tracking branch 'upstream/main'

ENCCS · Sep 9, 2024 · 3f71c19 · 3f71c19
2 parents e736181 + dad96ad
commit 3f71c19
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 2 deletions.
diff --git a/content/conf.py b/content/conf.py
@@ -44,7 +44,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
@@ -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 → content/guide.rst-if-wanted b/content/guide.rst → content/guide.rst-if-wanted
diff --git a/content/index.md 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 → content/index.rst-if-wanted b/content/index.rst → content/index.rst-if-wanted
diff --git a/content/quick-reference.md b/content/quick-reference.md
@@ -0,0 +1 @@
+# Quick Reference
diff --git a/content/quick-reference.rst → content/quick-reference.rst-if-wanted b/content/quick-reference.rst → content/quick-reference.rst-if-wanted
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 Sphinx
-sphinx_rtd_theme
+sphinx_rtd_theme>=2.0
 sphinx_rtd_theme_ext_color_contrast
 myst_nb
 sphinx-lesson