How to contribute to the project
Documentation
This documentation is written using sphinx. It follows the guidelines on writing technical documentation
set by Daniele Procida, and is contained in the docs
directory of the project.
In order to contribute to the documentation, the following packages should be added to the virtualenv on the developer machine:
sphinx
sphinx-django-command
sphinx-rtd-theme
sphinx-autobuild
pyembed-rst
Then, from inside the docs
directory:
make clean
make build html
The makefile
has been customised with respect to the original one generated by the sphinx-quickstart
script,
and it contains a livehtml
target, that allows to rebuild the html output each time the rst source files are
changed and saved.
make livehtml
Development
Source code is available on https://github.com/openpolis/django-uwsgi-taskmanager.
Tests can be launched with
python demo/manage.py test
The source code is tested for syntax and format using black.