Browse Source

adapt documentation to changed module structure

remotes/origin/HEAD
Jan Dittberner 7 years ago
parent
commit
41af99561c
  1. 5
      README.rst
  2. 24
      docs/code.rst
  3. 12
      docs/code/fileservertasks.rst
  4. 12
      docs/code/ldaptasks.rst
  5. 7
      docs/code/mysqltasks.rst
  6. 20
      docs/code/osusers.rst
  7. 8
      docs/code/pgsqltasks.rst
  8. 2
      gnuviechadmin/mysqltasks/tasks.py
  9. 2
      gnuviechadmin/pgsqltasks/tasks.py

5
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/

24
docs/code.rst

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

12
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:

12
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:

7
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:

20
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

8
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:

2
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

2
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

Loading…
Cancel
Save