Sphinx-lesson

Getting started

  • Getting started
  • Installation
  • Quickstart: Contributing to a lesson
  • Building the lesson
  • Changelog

Basic syntax

  • Markdown and ReST
  • Table of Contents tree
  • Directives
  • Figures

Examples

  • Sample episode in MyST (Markdown)
  • Sample episode in ReST

Advanced features

  • Intersphinx: easy linking
  • Markdown transforms
  • Jupyter notebook page
  • Executing code cells in MyST markdown
  • Substitutions and replacement variables
  • Deployment with Github Actions
  • Presentation mode
  • Indexing
  • Exercise list
  • Converting an old lesson

Extras

  • Cheatsheet
Sphinx-lesson
  • Search

© Copyright 2020-2024, CodeRefinery.

Built with Sphinx using a theme provided by Read the Docs.