update changelog, document test process

- fix headline in index.rst
- add release 0.1 in changelog and add two more features
- add tests.rst documenting how to run the test suite and how to check test
  coverage
This commit is contained in:
Jan Dittberner 2014-06-01 12:07:18 +02:00
parent c45e93be03
commit d82146987e
3 changed files with 33 additions and 1 deletions

View File

@ -1,5 +1,11 @@
Changelog
=========
* :feature:`-` initial test suite for models
* :feature:`-` `Celery <http://www.celeryproject.com/>`_ integration for ldap
synchronization
* :release:`0.1 <2014-05-25>`
* :feature:`-` initial model code for os users
* :feature:`-` initial model code for mail address and mailbox management
* :feature:`-` initial model code for domains

View File

@ -4,7 +4,7 @@
contain the root `toctree` directive.
Welcome to gnuviechadmin's documentation!
====================================
=========================================
Contents:

26
docs/tests.rst Normal file
View File

@ -0,0 +1,26 @@
Tests
=====
To run the tests you can just use the :program:`manage.py` script:
.. code-block:: sh
$ python manage.py test
Coverage
--------
To capture test coverage information you can run:
.. code-block:: sh
$ coverage run --branch manage.py test
To view the coverage data use:
.. code-block:: sh
$ coverage report -m
The coverage configuration is in :file:`.coveragerc`. Add new apps to the
`source` configuration in the `[run]` section of that configuration file.