Example project for testing / documentation tutorial. This repo contains some standard files to perform testing (with py.test and continuous integration with Travis CI) and files/scripts for automating documentation.
The master branch represents a fully set-up package with testing (and continuous integration), automatic documentation generation, and coverage reporting; the tryout branch can be used to "practice" setting up Sphinx, tests, etc.
To integrate all tools/functionality, make sure you have the following installed:
- Python 2.7 or 3.5
- sphinx (pip install sphinx)
- sphinx ReadTheDocs theme (pip install sphinx_rtd_theme)
- pytest (pip install pytest)
- pytest-cov (pip install pytest-cov)
- pytest-pep8 (pip install pytest-pep8)
- coveralls (pip install coveralls)