Browse Source

restructure generated code documentation

remotes/origin/HEAD
Jan Dittberner 7 years ago
parent
commit
2408feb4b1
  1. 2
      LICENSE.txt
  2. 54
      README.rst
  3. 235
      docs/code.rst
  4. 22
      docs/code/dashboard.rst
  5. 16
      docs/code/domains.rst
  6. 55
      docs/code/gnuviechadmin.rst
  7. 15
      docs/code/gvacommon.rst
  8. 18
      docs/code/managemails.rst
  9. 17
      docs/code/mysqltasks.rst
  10. 45
      docs/code/osusers.rst
  11. 17
      docs/code/pgsqltasks.rst
  12. 24
      docs/code/taskresults.rst
  13. 30
      docs/code/userdbs.rst
  14. 10
      docs/index.rst
  15. 47
      docs/install.rst

2
LICENSE.txt

@ -1,4 +1,4 @@
Copyright (c) 2014 Jan Dittberner.
Copyright (c) 2014, 2015 Jan Dittberner.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation

54
README.rst

@ -3,57 +3,3 @@ gnuviechadmin
=============
Customer center for gnuviech servers.
To use this project follow these steps:
#. Create your working environment
#. Install Django
#. Create the new project using the django-two-scoops template
#. Install additional dependencies
#. Use the Django admin to create the project
Working Environment
===================
You have several options in setting up your working environment. We recommend
using virtualenv to separate the dependencies of your project from your
system's python environment. If on Linux or Mac OS X, you can also use
virtualenvwrapper to help manage multiple virtualenvs across different
projects.
Virtualenv Only
---------------
First, make sure you are using virtualenv (http://www.virtualenv.org). Once
that's installed, create your virtualenv::
$ virtualenv --distribute gnuviechadmin
You will also need to ensure that the virtualenv has the project directory
added to the path. Adding the project directory will allow `django-admin.py` to
be able to change settings using the `--settings` flag.
Virtualenv with virtualenvwrapper
------------------------------------
In Linux and Mac OSX, you can install virtualenvwrapper
(http://virtualenvwrapper.readthedocs.org/en/latest/), which will take care of
managing your virtual environments and adding the project path to the
`site-directory` for you::
$ mkdir gnuviechadmin
$ mkvirtualenv -a gnuviechadmin gnuviechadmin-dev
$ cd gnuviechadmin && add2virtualenv `pwd`
Installation of Dependencies
=============================
Depending on where you are installing dependencies:
In development::
$ pip install -r requirements/local.txt
For production::
$ pip install -r requirements.txt

235
docs/code.rst

@ -10,226 +10,15 @@ administrators and customers.
.. _Django: https://www.djangoproject.com/
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
: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:
:py:mod:`managemails` app
=========================
.. automodule:: managemails
:py:mod:`admin <managemails.admin>`
-----------------------------------
.. automodule:: managemails.admin
:members:
:py:mod:`models <managemails.models>`
-------------------------------------
.. automodule:: managemails.models
:members:
: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
: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
: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
: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
:py:mod:`userdbs` app
=====================
.. automodule:: userdbs
:py:mod:`admin <userdbs.admin>`
-------------------------------
.. automodule:: userdbs.admin
:members:
:py:mod:`models <userdbs.models>`
---------------------------------
.. automodule:: userdbs.models
:members:
.. toctree::
code/gnuviechadmin
code/gvacommon
code/dashboard
code/domains
code/managemails
code/mysqltasks
code/osusers
code/pgsqltasks
code/taskresults
code/userdbs

22
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

16
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

55
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

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

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

17
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

45
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

17
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

24
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

30
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

10
docs/index.rst

@ -3,6 +3,16 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: ../README.rst
License
=======
gnuviechadmin is licensed under the terms of the MIT license:
.. include:: ../LICENSE.txt
:literal:
Welcome to gnuviechadmin's documentation!
=========================================

47
docs/install.rst

@ -1,4 +1,45 @@
Install
=========
Installation
============
This is where you write how to get a new laptop to run this project.
You have several options in setting up your working environment. We recommend
using virtualenv to separate the dependencies of your project from your
system's python environment. If on Linux or Mac OS X, you can also use
virtualenvwrapper to help manage multiple virtualenvs across different
projects.
Virtualenv Only
---------------
First, make sure you are using virtualenv (http://www.virtualenv.org). Once
that's installed, create your virtualenv::
$ virtualenv --distribute gnuviechadmin
You will also need to ensure that the virtualenv has the project directory
added to the path. Adding the project directory will allow `django-admin.py` to
be able to change settings using the `--settings` flag.
Virtualenv with virtualenvwrapper
------------------------------------
In Linux and Mac OSX, you can install virtualenvwrapper
(http://virtualenvwrapper.readthedocs.org/en/latest/), which will take care of
managing your virtual environments and adding the project path to the
`site-directory` for you::
$ mkdir gnuviechadmin
$ mkvirtualenv -a gnuviechadmin gnuviechadmin-dev
$ cd gnuviechadmin && add2virtualenv `pwd`
Installation of Dependencies
=============================
Depending on where you are installing dependencies:
In development::
$ pip install -r requirements/local.txt
For production::
$ pip install -r requirements.txt

Loading…
Cancel
Save