restructure generated code documentation

docs/code/dashboard.rst

@@ -0,0 +1,22 @@
+:py:mod:`dashboard` app
+=======================
+
+.. automodule:: dashboard
+
+
+:py:mod:`models <dashboard.models>`
+-----------------------------------
+
+.. automodule:: dashboard.models
+
+
+:py:mod:`urls <dashboard.urls>`
+-------------------------------
+
+.. automodule:: dashboard.urls
+
+
+:py:mod:`views <dashboard.views>`
+---------------------------------
+
+.. automodule:: dashboard.views

docs/code/domains.rst

@@ -0,0 +1,16 @@
+:py:mod:`domains` app
+=====================
+
+.. automodule:: domains
+
+
+:py:mod:`admin <domains.admin>`
+-------------------------------
+
+.. automodule:: domains.admin
+
+
+:py:mod:`models <domains.models>`
+---------------------------------
+
+.. automodule:: domains.models

docs/code/gnuviechadmin.rst

@@ -0,0 +1,55 @@
+The project module :py:mod:`gnuviechadmin`
+==========================================
+
+.. automodule:: gnuviechadmin
+
+
+:py:mod:`celery <gnuviechadmin.celery>`
+---------------------------------------
+
+.. automodule:: gnuviechadmin.celery
+   :members:
+
+
+:py:mod:`urls <gnuviechadmin.urls>`
+-----------------------------------
+
+.. automodule:: gnuviechadmin.urls
+
+
+:py:mod:`wsgi <gnuviechadmin.wsgi>`
+-----------------------------------
+
+.. automodule:: gnuviechadmin.wsgi
+   :members:
+
+
+:py:mod:`settings <gnuviechadmin.settings>`
+-------------------------------------------
+
+.. automodule:: gnuviechadmin.settings
+
+
+:py:mod:`base <gnuviechadmin.settings.base>`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gnuviechadmin.settings.base
+   :members:
+
+
+:py:mod:`local <gnuviechadmin.settings.local>`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gnuviechadmin.settings.local
+
+
+:py:mod:`production <gnuviechadmin.settings.production>`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gnuviechadmin.settings.production
+
+
+:py:mod:`test <gnuviechadmin.settings.test>`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: gnuviechadmin.settings.test

docs/code/gvacommon.rst

@@ -0,0 +1,15 @@
+:py:mod:`gvacommon`
+===================
+
+This module is imported from a separate git project via git subtree and
+provides some functionality that is common to all gnuviechadmin subprojects.
+
+.. automodule:: gvacommon
+
+
+:py:mod:`celeryrouters <gvacommon.celeryrouters>`
+-------------------------------------------------
+
+.. automodule:: gvacommon.celeryrouters
+   :members:
+   :undoc-members:

docs/code/managemails.rst

@@ -0,0 +1,18 @@
+:py:mod:`managemails` app
+=========================
+
+.. automodule:: managemails
+
+
+:py:mod:`admin <managemails.admin>`
+-----------------------------------
+
+.. automodule:: managemails.admin
+   :members:
+
+
+:py:mod:`models <managemails.models>`
+-------------------------------------
+
+.. automodule:: managemails.models
+   :members:

docs/code/mysqltasks.rst

@@ -0,0 +1,17 @@
+:py:mod:`mysqltasks` app
+========================
+
+.. automodule:: mysqltasks
+
+
+:py:mod:`tasks <mysqltasks.tasks>`
+----------------------------------
+
+.. 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

docs/code/osusers.rst

@@ -0,0 +1,45 @@
+:py:mod:`osusers` app
+=====================
+
+.. automodule:: osusers
+
+
+:py:mod:`admin <osusers.admin>`
+-------------------------------
+
+.. automodule:: osusers.admin
+   :members:
+
+
+:py:mod:`apps <osusers.apps>`
+-----------------------------
+
+.. automodule:: osusers.apps
+   :members:
+
+
+:py:mod:`models <osusers.models>`
+---------------------------------
+
+.. 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

@@ -0,0 +1,17 @@
+:py:mod:`pgsqltasks` app
+========================
+
+.. automodule:: pgsqltasks
+   :members:
+
+
+:py:mod:`tasks <pgsqltasks.tasks>`
+----------------------------------
+
+.. 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

docs/code/taskresults.rst

@@ -0,0 +1,24 @@
+:py:mod:`taskresults` app
+=========================
+
+.. automodule:: taskresults
+
+:py:mod:`admin <taskresults.admin>`
+-----------------------------------
+
+.. automodule:: taskresults.admin
+
+:py:mod:`management.commands <taskresults.management.commands>`
+---------------------------------------------------------------
+
+.. automodule:: taskresults.management.commands
+
+:py:mod:`fetch_taskresults <taskresult.management.commands.fetch_taskresults>`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: taskresults.management.commands.fetch_taskresults
+
+:py:mod:`models <taskresults.models>`
+-------------------------------------
+
+.. automodule:: taskresults.models

docs/code/userdbs.rst

@@ -0,0 +1,30 @@
+:py:mod:`userdbs` app
+=====================
+
+.. automodule:: userdbs
+
+
+:py:mod:`admin <userdbs.admin>`
+-------------------------------
+
+.. automodule:: userdbs.admin
+   :members:
+
+
+:py:mod:`apps <userdbs.apps>`
+-----------------------------
+
+.. automodule:: userdbs.apps
+
+
+:py:mod:`models <userdbs.models>`
+---------------------------------
+
+.. automodule:: userdbs.models
+   :members:
+
+
+:py:mod:`views <userdbs.views>`
+-------------------------------
+
+.. automodule:: userdbs.views