# Porting Carpentries course material to sphinx-lesson format

Show and tell by example of [ENCCS/deep-learning-intro](https://github.com/ENCCS/deep-learning-intro)

Rendered result

- https://carpentries-lab.github.io/deep-learning-intro/
- https://enccs.github.io/deep-learning-intro/

Goals: fork, but stay in sync with upstream
Assumptions: Carpentries episodes are static md, not executed Rmd

## Steps

1. Fork a carpentries course
2. Create a `sphinx` branch
3. Disable sandpaper related Github Actions
4. Make the following ==structural changes==

## Structural changes

- [`episodes/`](https://github.com/ENCCS/deep-learning-intro/tree/sphinx/episodes) : Keep changes to a minimum to avoid merge conflicts
- [`content/`](https://github.com/ENCCS/deep-learning-intro/tree/sphinx/content) : Where the sphinx + Myst Markdown witchcraft happens
- [`patch.py`](https://github.com/ENCCS/deep-learning-intro/tree/sphinx/patch.py) : The regex magic wand which generates `content/patched/` which is git-ignored (for now)
- [`Makefile`](https://github.com/ENCCS/deep-learning-intro/tree/sphinx/Makefile) : Some minor changes to include `patch.py`

The rest is the same as sphinx-lesson-template

## What do you think?
- OMG, I won't touch this without a 10-foot pole:
- OK, good enough:
- This is amazing:

Suggestions for improvements:
- ...
- ...