DOCS.md

Building the docs

Make a Python virtual environment, e.g.

mkdir ~/.venv
python -m venv ~/.venv/docs
. ~/.venv/docs/bin/activate

Install the following python modules:

pip install --upgrade pip
pip install mkdocs
pip install mkdocs-material

To build:

mkdocs build

View locally:

mkdocs serve

access at http://127.0.0.1:8000

Deploy:

mkdocs gh-deploy