For all the code in Savanna we have a rule - it should pass PEP 8.
To check your code against PEP 8 run:
$ tox -e pep8
For more details on coding guidelines see file HACKING.rst in the root of Savanna repo.
Savanna has a suite of tests that are run on all submitted code, and it is recommended that developers execute the tests themselves to catch regressions early. Developers are also expected to keep the test suite up-to-date with any submitted code changes.
Unit tests are located at savanna/tests.
Savanna’s suite of unit tests can be executed in an isolated environment with Tox. To execute the unit tests run the following from the root of Savanna repo:
$ tox -e py27
All Savanna docs are written using Sphinx / RST and located in the main repo in doc directory. You can add/edit pages here to update https://savanna.readthedocs.org/en/latest/ site.
Run the following command to build docs locally.
$ tox -e docs
After it you can access generated docs in doc/build/ directory, for example, main page - doc/build/html/index.html.
To make docs generation process faster you can use:
$ SPHINX_DEBUG=1 tox -e docs
or to avoid savanna reinstallation to virtual env each time you want to rebuild docs you can use the following command (it could be executed only after running tox -e docs first time):
$ SPHINX_DEBUG=1 .tox/docs/bin/python setup.py build_sphinx
For more details on documentation guidelines see file HACKING.rst in the root of Savanna repo.