This project uses MkDocs documentation generator.

If you set up your project by walking through Getting Started For Local Development, run the following command:

 cd docs
 docker-compose -p metagrid_docs_dev up

Navigate to port 8001 on your host to see the documentation site locally (e.g. localhost:8001). MkDocs supports hot-reloading, so changes to any of the .md files will reload the site.

Setting up ReadTheDocs

To setup your documentation on ReadTheDocs, you must

  1. Go to ReadTheDocs and login/create an account
  2. Add your GitHub repository
  3. Trigger a build

Additionally, you can auto-build Pull Request previews, but you must enable it.

Here's a guide specifically for MkDocs