This is a demo for the sphinx-lesson style, and also a template which can be used for creating new lessons.
- Sphinx
- ReST
- Markdown via the myst_parser parser, so has access to all Sphinx directives natively
- Automatically building via Github Actions and automatic deployment to Github Pages.
- Directives for exercises/prereq/etc, works in both ReST and md.
- The Sphinx part can be separated into a separately installable and versionable Python package, so we don't need sub-modules.
- Jupyter includes, including executing the notebook (via
myst_nb
). - Execute code cells in markdown (via
myst_nb
).
... it may be necessary to flip the github pages config setting to master and back, and then re-push.