About the Handprint docs

This page describes how to (re)create the formatted Handprint documentation.

Building the docs locally

First, install MyST and Sphinx:

python3 -m pip install "myst-parser[linkify]"
python3 -m pip install sphinx-material
python3 -m pip install sphinx-autobuild

After that, rebuilding the docs is simply a matter of running make html in the current directory:

make html

The output will be put in _build/html. Instead of running make deliberately, you can also get auto-rebuilds and live preview using sphinx-autobuild by running the following command in the current directory (preferably in a new terminal window, because it will generate continuous output):

make auto

Writing documentation

This documentation is written in MyST-flavored Markdown and the Napoleon extension to Sphinx. What this means is that the documentation is written in Markdown instead of reStructuredText, with essentially all the features of Sphinx and reStructuredText having MyST equivalents and some additional features beyond that – things like pandoc-style footnotes, LaTeX math, and more.