5. Misc

This chapter covers miscellaneous things which are not related to the library usage.

5.1. Tests

See the output of tests execution at Travis CI.

If you need to run tests locally, you need to have nose installed. Then just run

$ nosetests

to run all tests inside the project.

Visit Coveralls to see the tests coverage online.

If you need to see coverage locally, install coverage additionally. Then run:

$ coverage run `which nosetests` --nocapture && coverage report -m

5.2. Building docs

If you need to have a local copy of these docs, you will need to install Sphinx and make. Then:

$ cd docs
$ make html

This will render docs in HTML format to docs/_build/html directory.

To see all available output formats, run:

$ make help