DOCS.md

Building the Documentation

To create the html version of the documentation do the following. After you have installed the package, install the the additional requirements using

> pip install -r requirements-docs.txt

Then run

> mkdocs serve 

to start a local server hosting the site, or run

> mkdocs build 

to build a static html version of the documentation (which can be found in the folder sites). Both of the above uses the mkdocs.yml file to build the documentation. Please see the mkdocs documentation for additional information.