Introduction
This documentation is built using mkdocs, a static site generator that is geared towards building project documentation. The documentation is created in the Markdown format, and it all resides in the docs directory in the repository. The organization of the documentation is controlled by the mkdocs.yml in the root of the repository.
Prerequisites
You will need to have mkdocs installed locally, as well as the mkdocs theme.
Install mkdocs:
sudo -H pip install mkdocs
Install material theme:
sudo -H pip install mkdocs-material
Build and Deploy documentation
Make sure you have all the submodules:
git submodule update --init --recursive
Documentation is build by running to the following command in the root of the repository:
mkdocs build --clean
This command will create a static site folder in the root of the repository.
You can preview any changes you have made to the documentation by running the following command:
mkdocs serve
And then visiting http://localhost:8111 in your browser.
To deploy documenation to GitHub Pages, issue the following command:
mkdocs gh-deploy --clean