Refactored documentation.

This commit is contained in:
Antoine Nguyen
2016-10-18 17:28:34 +02:00
parent 3decd518ad
commit e4e4e4c53c
27 changed files with 451 additions and 1182 deletions
+29 -3
View File
@@ -1,4 +1,30 @@
Rules
=================
#################
How to contribute
#################
.. include:: ../CONTRIBUTING.rst
Contributions are always welcome but please try to follow those few rules:
- Modoboa tries to respect the `PEP8 <https://www.python.org/dev/peps/pep-0008/>`_
- If you add some code, add some tests too. You can run the tests
suite locally by using `tox <https://testrun.org/tox/latest/config.html>`_
There are also a few commands that can help you to contribute:
Start a basic Modoboa instance with a few fixture::
$ tox -e serve
You can log in with admin/password.
Build the docs to see your changes::
$ tox -e doc
$ firefox .tox/doc/tmp/html/index.html
.. toctree::
contributing/getting_started
contributing/plugin_api
contributing/events