Skip to content

Documentation

Project documentation lives in /docs and is written in Markdown.

For web-based access, these files are passed through a static site generator MkDocs, specifically MkDocs Material and served via Github Pages.

Development

You can run a live-reloading web server in imitation of the production generator. To do so:

  • Ensure that your python environment is using python3 and its package manager pip3. You can then install the required mkdocs executable and its dependencies using:
    1
    python -m pip install -r requirements-mkdocs.txt
    
  • Run mdkocs serve from the project root. A convenience Make command is likewise provided as make mkdocs-serve.
  • Open http://localhost:8000 in a web browser.
  • Write some docs!

Last update: 2022-06-28