adapt documentation to changed module structure

README.rst

@@ -3,3 +3,8 @@ gnuviechadmin
 =============
 
 Customer center for gnuviech servers.
+
+Gnuviechadmin is based on Django_ and Celery_
+
+.. _Django: https://djangoproject.com/
+.. _Celery: http://www.celeryproject.com/

docs/code.rst

@@ -9,17 +9,35 @@ administrators and customers.
 
 .. _Django: https://www.djangoproject.com/
 
+Common code
+===========
+
+.. toctree::
+
+   code/gvacommon
+
+
+Celery task stubs
+=================
+
+.. toctree::
+
+   code/fileservertasks
+   code/ldaptasks
+   code/mysqltasks
+   code/pgsqltasks
+
+
+Django app code
+===============
 
 .. toctree::
 
    code/gnuviechadmin
-   code/gvacommon
    code/dashboard
    code/domains
    code/hostingpackages
    code/managemails
-   code/mysqltasks
    code/osusers
-   code/pgsqltasks
    code/taskresults
    code/userdbs

docs/code/fileservertasks.rst

@@ -0,0 +1,12 @@
+:py:mod:`fileservertasks` app
+=============================
+
+.. automodule:: fileservertasks
+
+
+:py:mod:`tasks <fileservertasks.tasks>`
+---------------------------------------
+
+.. automodule:: fileservertasks.tasks
+   :members:
+   :undoc-members:

docs/code/ldaptasks.rst

@@ -0,0 +1,12 @@
+:py:mod:`ldaptasks` app
+=======================
+
+.. automodule:: ldaptasks
+
+
+:py:mod:`tasks <ldaptasks.tasks>`
+---------------------------------
+
+.. automodule:: ldaptasks.tasks
+   :members:
+   :undoc-members:

docs/code/mysqltasks.rst

@@ -9,9 +9,4 @@
 
 .. automodule:: mysqltasks.tasks
    :members:
-
+   :undoc-members:
-.. autotask:: mysqltasks.tasks.create_mysql_database
-.. autotask:: mysqltasks.tasks.create_mysql_user
-.. autotask:: mysqltasks.tasks.delete_mysql_database
-.. autotask:: mysqltasks.tasks.delete_mysql_user
-.. autotask:: mysqltasks.tasks.set_mysql_userpassword

docs/code/osusers.rst

@@ -23,23 +23,3 @@
 
 .. automodule:: osusers.models
    :members:
-
-
-:py:mod:`tasks <osusers.tasks>`
--------------------------------
-
-.. automodule:: osusers.tasks
-
-.. autotask:: osusers.tasks.add_ldap_user_to_group
-.. autotask:: osusers.tasks.create_file_mailbox
-.. autotask:: osusers.tasks.create_ldap_group
-.. autotask:: osusers.tasks.create_ldap_user
-.. autotask:: osusers.tasks.delete_file_mail_userdir
-.. autotask:: osusers.tasks.delete_file_mailbox
-.. autotask:: osusers.tasks.delete_file_sftp_userdir
-.. autotask:: osusers.tasks.delete_ldap_group
-.. autotask:: osusers.tasks.delete_ldap_group_if_empty
-.. autotask:: osusers.tasks.delete_ldap_user
-.. autotask:: osusers.tasks.remove_ldap_user_from_group
-.. autotask:: osusers.tasks.setup_file_mail_userdir
-.. autotask:: osusers.tasks.setup_file_sftp_userdir

docs/code/pgsqltasks.rst

@@ -9,9 +9,5 @@
 ----------------------------------
 
 .. automodule:: pgsqltasks.tasks
-
+   :members:
-.. autotask:: pgsqltasks.tasks.create_pgsql_database
+   :undoc-members:
-.. autotask:: pgsqltasks.tasks.create_pgsql_user
-.. autotask:: pgsqltasks.tasks.delete_pgsql_database
-.. autotask:: pgsqltasks.tasks.delete_pgsql_user
-.. autotask:: pgsqltasks.tasks.set_pgsql_userpassword

gnuviechadmin/mysqltasks/tasks.py

@@ -1,5 +1,5 @@
 """
-This module defines Celery_ tasks to manage MySQL users and databases.
+This module defines Celery tasks to manage MySQL users and databases.
 
 """
 from __future__ import absolute_import

gnuviechadmin/pgsqltasks/tasks.py

@@ -1,5 +1,5 @@
 """
-This module defines Celery_ tasks to manage PostgreSQL users and databases.
+This module defines Celery tasks to manage PostgreSQL users and databases.
 
 """
 from __future__ import absolute_import