testing

All below code blocks should be run from the root directory of the butterfly repository.

Run unit tests

This runs all tests in the tests directory.

nosetests tests

Test docs locally

This installs everything needed to build the docs.

pip install -r docs/requirements.txt

This generates a local copy of the docs and serves them on port 1337.

sphinx-autobuild docs/source/ docs/build/ -p 1337 -EH 0.0.0.0 -i **/global.rst -z bfly

Writing docstrings

While it should be supported according to the Sphinx Spec, readthedocs.io fails to run autodoc on class attributes. We've set up two conventions for doing this ourselves.