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

If you want to build and test the site directly on your local machine without the use of docker container, follow the below steps:

1. Install the dependencies from the root of this repository using the pip command
   pip install -r docs/requirements.txt

2. Build the docs site locally from the root
   make build-docs-local

3. Start the docs site locally
   make serve-docs-local

Analytics

We collect Google Analytics.