Documentation Site

Developing And Testing

The documentation website is built using mkdocs and mkdocs-material.

To test:

make serve-docs

Once running, you can view your locally built documentation at http://0.0.0.0:8000/. Making changes to documentation will automatically rebuild and refresh the view.

Before submitting a PR build the website, to verify that there are no errors building the site

make build-docs

Analytics

Tip

Don't forget to disable your ad-blocker when testing.

We collect Google Analytics.