Documentation

We use MkDocs to generate our documentation. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Installation

• Install Python and pip.
• Install the MkDocs package using pip: pip install mkdocs
• Install the Material for MkDocs theme using pip: pip install mkdocs-material

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Deploy

Once the documentation is ready, you can create a pull request to the develop branch. Once the PR is merged, the documentation will be automatically deployed to GitHub Pages by a GitHub Action when the develop branch is merged to main.