From d82146987eb6183290d11290354ac3c7bd865a89 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Sun, 1 Jun 2014 12:07:18 +0200 Subject: [PATCH] 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 --- docs/changelog.rst | 6 ++++++ docs/index.rst | 2 +- docs/tests.rst | 26 ++++++++++++++++++++++++++ 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/tests.rst diff --git a/docs/changelog.rst b/docs/changelog.rst index 9826f7d..c3bff99 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,5 +1,11 @@ Changelog ========= +* :feature:`-` initial test suite for models +* :feature:`-` `Celery `_ 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 diff --git a/docs/index.rst b/docs/index.rst index 425bea4..0d9e0c2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Welcome to gnuviechadmin's documentation! -==================================== +========================================= Contents: diff --git a/docs/tests.rst b/docs/tests.rst new file mode 100644 index 0000000..b56edd1 --- /dev/null +++ b/docs/tests.rst @@ -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.