Improve documentation

This commit adds a lot of documentation including block diagramms for
message flows.

docs/code/osusers.rst

@@ -31,6 +31,12 @@
 .. automodule:: osusers.models
    :members:
 
+:py:mod:`signals <osusers.signals>`
+-----------------------------------
+
+.. automodule:: osusers.signals
+   :members:
+
 
 :py:mod:`urls <osusers.urls>`
 -----------------------------

docs/code/userdbs.rst

@@ -30,6 +30,12 @@
 .. automodule:: userdbs.models
    :members:
 
+:py:mod:`signals <userdbs.signals>`
+-----------------------------------
+
+.. automodule:: userdbs.signals
+   :members:
+
 :py:mod:`templatetags <userdbs.templatetags>`
 ---------------------------------------------
 

docs/conf.py

@@ -33,12 +33,17 @@ django.setup()
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx']
+extensions = [
+    'releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx',
+    'sphinxcontrib.blockdiag']
 
 # configuration for releases extension
 releases_issue_uri = 'https://dev.gnuviech-server.de/gva/ticket/%s'
 releases_release_uri = 'https://dev.gnuviech-server.de/gva/browser/?rev=%s'
 
+# configuration for blockdiag extension
+blockdiag_fontpath = '/usr/share/fonts/truetype/dejavu/'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/index.rst

@@ -9,6 +9,20 @@ Welcome to gnuviechadmin's documentation!
 
 .. include:: ../README.rst
 
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 3
+
+   install
+   deploy
+   tests
+   code
+   ideas
+   task_flows
+   changelog
+
 License
 -------
 
@@ -20,19 +34,6 @@ later version.
 .. include:: ../COPYING
    :literal:
 
-Contents
---------
-
-.. toctree::
-   :maxdepth: 2
-
-   install
-   deploy
-   tests
-   code
-   ideas
-   changelog
-
 
 Indices and tables
 ------------------

docs/task_flows.rst

@@ -0,0 +1,35 @@
+**********
+Task Flows
+**********
+
+gva uses Celery tasks to trigger actions on several servers, this chapter lists
+the code parts that start tasks. See the code documentation for details on the
+information flow.
+
+:py:mod:`osusers.admin`
+=======================
+
+ * :py:meth:`osusers.admin.SshPublicKeyAdmin.perform_delete_selected`
+
+
+:py:mod:`osusers.signals`
+=========================
+
+ * :py:func:`osusers.signals.handle_group_created`
+ * :py:func:`osusers.signals.handle_group_deleted`
+ * :py:func:`osusers.signals.handle_ssh_keys_changed`
+ * :py:func:`osusers.signals.handle_user_added_to_group`
+ * :py:func:`osusers.signals.handle_user_created`
+ * :py:func:`osusers.signals.handle_user_deleted`
+ * :py:func:`osusers.signals.handle_user_password_set`
+ * :py:func:`osusers.signals.handle_user_removed_from_group`
+
+
+:py:mod:`userdbs.signals`
+=========================
+
+ * :py:func:`userdbs.signals.handle_dbuser_created`
+ * :py:func:`userdbs.signals.handle_dbuser_deleted`
+ * :py:func:`userdbs.signals.handle_dbuser_deleted`
+ * :py:func:`userdbs.signals.handle_dbuser_password_set`
+ * :py:func:`userdbs.signals.handle_userdb_created`