Sphinx-lesson
0.8.3

Getting started

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

Basic syntax

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

Examples

  • Sample episode in ReST
  • Sample episode in MyST Markdown

Advanced features

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

Extras

  • Cheatsheet
Sphinx-lesson
  • »
  • Search

© Copyright 2020, CodeRefinery.

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