loorlab / matrix-documentation

Documentation describing MATRIX OS and APIs.

README

MATRIX Documentation uses MkDocs to format and compile Markdown into a HTML site.

Install Dependencies

1. Install pip and virtualenv if you do not already have them.
2. Create a virtualenv. Samples compatible with Python 2.7 and 3.4+.
3. Optionally you may also want to install virtualenv wrapper to make your life easier.

$ virtualenv env
$ source env/bin/activate

# Do this to get the docs running locally.
pip install --upgrade -r requirements.txt
mkdocs serve

Deployment

mkdocs gh-deploy --clean

That's it.

http://matrix-io.github.io/matrix-documentation