Topomine: documentation

Documentation based on Material for MkDocs.

Installation

Dependencies

• python >= 3.12

Virtual environment

Create a virtualenv

virtualenv -p python3.12 venv

or

python3.12 -m venv venv

Install Python dependencies

make develop

MkDocs

Serve the documentation

make serve

Build static site

make dist

Clean static site

make clean

Clean existing static site, build an updated version, including a zip archive

make dist-zip