Run unit tests with make runtests
. There are unit tests in the boilerplate.tests
submodule, and
there are doctests throughout the boilerplate
module. The code coverage results are viewable with
make viewcoverage
.
I've never used Sphinx in an actual project before (it's been on the TODO list though) so it may not
be configured quite right. To write the documentation, edit the docs/*.rst
files to your liking,
then build the documentation. I recommend one of two ways:
- HTML:
make html
thenmake viewhtml
- LaTeX:
make latex
thenmake viewlatex
Simply running make
will display the options available.
- Get
setup.py
fully figured out - Document how to configure Sphinx