Documentation available online here.
If you wish to generate the documentation yourself (mainly if you wish to generate a PDF file, which Travis does not do), you will need to follow the below steps.
- Navigate to doc directory
- Execute
make rst - Execute
make latexpdf(if you want PDF output) - Execute
make html(if you want HTML output) - Documentation should now be found in the
_builddirectory underneath doc. The top levelindex.htmlfile will redirect to the appropriate place, just open it up.
Please test your build before pushing it. To test your build, simply run:
python setup.py test -a "--cov dessn -v"
If you want to see what statements are not covered up code tests, generate the HTML output via:
python setup.py test -a "--cov dessn -v --cov-report html"