Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert ReST to MyST #14

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion content/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down
17 changes: 17 additions & 0 deletions content/guide.md
Original file line number Diff line number Diff line change
@@ -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
File renamed without changes.
37 changes: 37 additions & 0 deletions content/index.md
Original file line number Diff line number Diff line change
@@ -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
File renamed without changes.
1 change: 1 addition & 0 deletions content/quick-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Quick Reference
File renamed without changes.
Loading