Skip to content

Updating These Docs

Built using MkDocs:


Install mkdocs and the material theme

pip install mkdocs-material

Viewing Locally

Start the live web-server with

mkdocs serve

View at http://localhost:8000

Deploying to GitHub Pages

Build and deploy with

mkdocs gh-deploy

This will push to the gh-pages branch of the current git remote.

The navigation bar is configured via the mkdocs.yml file in the repository root.