Documentation is stored under the docs
docs/ directory in the backend repository. Documentation built using MkDocs. Documentation is written using Markdown. Check out the MkDocs documentation for more information.
Building the Docs Site Locally¶
Install the docs dependencies
We recommend creating a python virtual environment to install the documentation requirements in.
Run the documentation service.
Navigate to http://localhost:8000 to view the docs site.
Adding new pages¶
- Create a new markdown file under
- Add your new file under the "nav" section in
mkdocs.ymlin the project root directory.