Feature/docs (#165)

* initial readthedocs commit

* docs moved to sphinx / rst / read the docs
This commit is contained in:
Tom Pallister
2017-11-25 15:03:50 +00:00
committed by GitHub
parent 48b5a32676
commit 923276651d
29 changed files with 1973 additions and 1 deletions

24
docs/building/tests.rst Normal file
View File

@ -0,0 +1,24 @@
Tests
=====
The tests should all just run and work apart from the integration tests which need the following
environmental variables setting. This is a manual step at the moment.
``OCELOT_USERNAME=admin``
``OCELOT_HASH=kE/mxd1hO9h9Sl2VhGhwJUd9xZEv4NP6qXoN39nIqM4=``
``OCELOT_SALT=zzWITpnDximUNKYLiUam/w==``
On windows you can use..
``SETX OCELOT_USERNAME admin``
On mac..
``export OCELOT_USERNAME=admin``
I need to work out a nicer way of doing this in the future.