Skip to content

Commit 3f71c19

Browse files
committed
Merge remote-tracking branch 'upstream/main'
2 parents e736181 + dad96ad commit 3f71c19

8 files changed

+62
-2
lines changed

content/conf.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,12 @@
4444
# jupyter_execute_notebooks = "off"
4545
# jupyter_execute_notebooks = "auto" # *only* execute if at least one output is missing.
4646
# jupyter_execute_notebooks = "force"
47-
jupyter_execute_notebooks = "cache"
47+
nb_execution_mode = "cache"
48+
49+
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
50+
myst_enable_extensions = [
51+
"colon_fence",
52+
]
4853

4954
# Add any paths that contain templates here, relative to this directory.
5055
# templates_path = ['_templates']

content/guide.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Instructor's guide
2+
3+
## Why we teach this lesson
4+
5+
## Intended learning outcomes
6+
7+
## Timing
8+
9+
## Preparing exercises
10+
11+
e.g. what to do the day before to set up common repositories.
12+
13+
## Other practical aspects
14+
15+
## Interesting questions you might get
16+
17+
## Typical pitfalls
File renamed without changes.

content/index.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# LESSON NAME
2+
3+
Intro
4+
5+
:::{prereq}
6+
prerequisites
7+
:::
8+
9+
```{csv-table}
10+
:delim: ;
11+
:widths: auto
12+
13+
20 min ; {doc}`filename`
14+
```
15+
16+
```{toctree}
17+
:caption: The lesson
18+
:maxdepth: 1
19+
```
20+
21+
```{toctree}
22+
:caption: Reference
23+
:maxdepth: 1
24+
25+
quick-reference
26+
guide
27+
```
28+
29+
(learner-personas)=
30+
31+
## Who is the course for?
32+
33+
## About the course
34+
35+
## See also
36+
37+
## Credits
File renamed without changes.

content/quick-reference.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Quick Reference
File renamed without changes.

requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Sphinx
2-
sphinx_rtd_theme
2+
sphinx_rtd_theme>=2.0
33
sphinx_rtd_theme_ext_color_contrast
44
myst_nb
55
sphinx-lesson

0 commit comments

Comments
 (0)