ChaosIQ Documentation

Public documentation for ChaosIQ

This project is based on MkDocs, a Python documentation generator based on Markdown.

To get started, install Python 3 on your machine, a virtual environment and install the dependencies using pip as follows:

$ pip install -r requirements.txt

Finally you can start a local server to view the docs:

$ mkdocs serve

To run mkdocs on an alternative port:

mkdocs serve --dev-addr 127.0.0.1:9000

If you wish to contribute to this documentation, please submit a PR with your changes for review.