gnuviech/gvaldap
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

add documentation for gvaldap project code

Browse source
This commit is contained in:
Jan Dittberner 2014-05-31 16:12:36 +02:00
parent d86ba33f21
commit 4f4247ea9d
10 changed files with 100 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

57
docs/code.rst
View file

@ -4,9 +4,64 @@ Code documentation
.. index:: Django
gvaldap is implemented as a set of `Django`_ apps.
gvaldap is implemented as `Django`_ project and provides some `Celery`_ tasks.
.. _Django: https://www.djangoproject.com/
.. _Celery: http://www.celeryproject.org/
The project module :py:mod:`gvaldap`
====================================
.. automodule:: gvaldap
:py:mod:`gvaldap.celery`
------------------------
.. automodule:: gvaldap.celery
:members:
:py:mod:`gvaldap.urls`
----------------------
.. automodule:: gvaldap.urls
:py:mod:`gvaldap.wsgi`
----------------------
.. automodule:: gvaldap.wsgi
:members:
:py:mod:`gvaldap.settings`
--------------------------
.. automodule:: gvaldap.settings
:py:mod:`gvaldap.settings.base`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.base
:members:
:py:mod:`gvaldap.settings.local`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.local
:py:mod:`gvaldap.settings.production`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.production
:py:mod:`gvaldap.settings.test`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.test
:py:mod:`ldapentities` app