MkDocs

We are using MkDocs to generate our documentation. See Docker-mkdocs repo for information about MkDocs and the image we're using.

Work on docs locally

The first time starting the container may take longer due to downloading the ~40MB docker image

1. Run the mkdocs container.

   docker-compose up mkdocs # (1)!
   

   1. Optionally use the -d flag to run the container in the background

2. Open a browser to http://localhost:8005/ to view the documentation locally.

3. Modify the files in the docs directory. The site will auto-update when the files are saved.

4. Ctrl+C to quit the local server and stop the container

Auto-generated docs

We have a GitHub Action set up to generate and host the documentation on a GitHub Pages site