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.
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
- Go to ReadTheDocs and login/create an account
- Add your GitHub repository
- Trigger a build
Additionally, you can auto-build Pull Request previews, but you must enable it.
Here's a guide specifically for MkDocs