This project documentation is automatically built using Sphinx, and published on https://readthedocs.io, see links below.
CI Status: | |
---|---|
Contributors: | Arthur Van de Wiele |
Project Links: |
This template offers a concise but extensive set of tools to ease your development cycles and let you focus on what matters.
Code Syntax Check: | Code quality is enforced using pylint |
---|---|
Unit Testing: | A test/ folder collects unit tests, and pytest in
conjunction with unittest libraries can be used to write and
execute these tests. |
Code Coverage: | Coverage based on the unit tests is automatically compiled, and linked to http://codecov.io |
Dev Documentation: | Developer's documentation can be extracted from the source code using
sphinx and rendered in html format, and is integrated with
https://readthedocs.io for automated doc builds. |
Continuous Integration: | All configuration files for using Travis and Codecov is already
provided, and relies on the aforementioned unit tests and coverage. |
Custom Tools & Scripts: | Some extra tools are provided for ease of life. |