Documentation Site

We use Material for MkDocs to generate this documentation site.

The site is automatically deployed to GitHub Pages when a new commit contains changes to the docs/ directory. See the corresponding GitHub Actions for more details.

Run Locally

To run the site locally, first install the package.

pip install mkdocs-material

Then run the following command and open http://127.0.0.1:8000/ in your browser.

mkdocs serve