x/surveil
Code Issues Proposed changes

Docs: Running the tests

Browse Source 
Change-Id: Iab621ad1bbea74e0fc70948126801d9ca885d9a2
This commit is contained in:
aviau 2015-06-09 14:09:38 -04:00
parent 207b2bad3b
commit 8164348851
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/tutorials/index.rst
View File

@ -6,3 +6,4 @@ Tutorials
getting_started
developing_the_api
running_the_tests

26
doc/source/tutorials/running_the_tests.rst Normal file
View File

@ -0,0 +1,26 @@
Running the tests
-----------------
Using tox
`````````
Surveil is tested and supported on Python 2.7 and Python 3.4. The project uses tox to manage tests.
The following command will run the tests for Python 3.4, Python 2.7, Flake8 and Docs: ::
tox
You can also run only one set of tests by specifying the tox environment to run (see tox.ini for more details): ::
tox -epy27
Building the docs
`````````````````
To build the docs, simply run ``tox -edocs``. The docs will be available in the ``doc/build/html`` folder. After every commit, docs are automatically built on readthedocs and hosted on `surveil.readthedocs.org <http://surveil.readthedocs.org/>`_.
Integration tests
`````````````````
Integration tests are ran nightly on `test.savoirfairelinux.net <https://test.savoirfairelinux.com/job/Surveil>`_. You can run them on your machine with ``tox -eintegration``. Before you launch the command, make sure that you don't have any other Surveil containers running as they may interfere with the integration tests. Integration tests will create muliple containers on your machine.