Docs

The documentation uses mkdocs to render the content.

Test changes

# Install the requirements first
pip install -r requirements.txt

# Start the mkdocs server in development mode
mkdocs serve

Alternatively you can use a docker container:

docker build . -t docs
docker run -it --rm -p 8000:8000 -v $PWD:/docs docs

Deployment

The main branch is automatically deployed to docs.strangebee.com

If not:

mkdocs gh-deploy --remote-branch gh-pages