From 41af99561ccde3b46ff0ff2073110d7e2beb86ae Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Mon, 19 Jan 2015 21:54:13 +0100 Subject: [PATCH] adapt documentation to changed module structure --- README.rst | 5 +++++ docs/code.rst | 24 +++++++++++++++++++++--- docs/code/fileservertasks.rst | 12 ++++++++++++ docs/code/ldaptasks.rst | 12 ++++++++++++ docs/code/mysqltasks.rst | 7 +------ docs/code/osusers.rst | 20 -------------------- docs/code/pgsqltasks.rst | 8 ++------ gnuviechadmin/mysqltasks/tasks.py | 2 +- gnuviechadmin/pgsqltasks/tasks.py | 2 +- 9 files changed, 55 insertions(+), 37 deletions(-) create mode 100644 docs/code/fileservertasks.rst create mode 100644 docs/code/ldaptasks.rst diff --git a/README.rst b/README.rst index 3d0de85..8aad2f0 100644 --- a/README.rst +++ b/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/ diff --git a/docs/code.rst b/docs/code.rst index d5f720c..adc9570 100644 --- a/docs/code.rst +++ b/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 diff --git a/docs/code/fileservertasks.rst b/docs/code/fileservertasks.rst new file mode 100644 index 0000000..9928d70 --- /dev/null +++ b/docs/code/fileservertasks.rst @@ -0,0 +1,12 @@ +:py:mod:`fileservertasks` app +============================= + +.. automodule:: fileservertasks + + +:py:mod:`tasks ` +--------------------------------------- + +.. automodule:: fileservertasks.tasks + :members: + :undoc-members: diff --git a/docs/code/ldaptasks.rst b/docs/code/ldaptasks.rst new file mode 100644 index 0000000..1d82d26 --- /dev/null +++ b/docs/code/ldaptasks.rst @@ -0,0 +1,12 @@ +:py:mod:`ldaptasks` app +======================= + +.. automodule:: ldaptasks + + +:py:mod:`tasks ` +--------------------------------- + +.. automodule:: ldaptasks.tasks + :members: + :undoc-members: diff --git a/docs/code/mysqltasks.rst b/docs/code/mysqltasks.rst index 80e31ed..b856ed1 100644 --- a/docs/code/mysqltasks.rst +++ b/docs/code/mysqltasks.rst @@ -9,9 +9,4 @@ .. automodule:: mysqltasks.tasks :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 + :undoc-members: diff --git a/docs/code/osusers.rst b/docs/code/osusers.rst index caa8d05..46d72cb 100644 --- a/docs/code/osusers.rst +++ b/docs/code/osusers.rst @@ -23,23 +23,3 @@ .. automodule:: osusers.models :members: - - -:py:mod:`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 diff --git a/docs/code/pgsqltasks.rst b/docs/code/pgsqltasks.rst index 3003498..2352957 100644 --- a/docs/code/pgsqltasks.rst +++ b/docs/code/pgsqltasks.rst @@ -9,9 +9,5 @@ ---------------------------------- .. automodule:: pgsqltasks.tasks - -.. autotask:: pgsqltasks.tasks.create_pgsql_database -.. autotask:: pgsqltasks.tasks.create_pgsql_user -.. autotask:: pgsqltasks.tasks.delete_pgsql_database -.. autotask:: pgsqltasks.tasks.delete_pgsql_user -.. autotask:: pgsqltasks.tasks.set_pgsql_userpassword + :members: + :undoc-members: diff --git a/gnuviechadmin/mysqltasks/tasks.py b/gnuviechadmin/mysqltasks/tasks.py index cda59d4..7c45e28 100644 --- a/gnuviechadmin/mysqltasks/tasks.py +++ b/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 diff --git a/gnuviechadmin/pgsqltasks/tasks.py b/gnuviechadmin/pgsqltasks/tasks.py index 5aa40d6..31e6dc3 100644 --- a/gnuviechadmin/pgsqltasks/tasks.py +++ b/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