gvaldap/docs/code.rst

98 lines
1.8 KiB
ReStructuredText

==================
Code documentation
==================
.. index:: Django
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:`celery <gvaldap.celery>`
---------------------------------
.. automodule:: gvaldap.celery
:members:
:py:mod:`urls <gvaldap.urls>`
-----------------------------
.. automodule:: gvaldap.urls
:py:mod:`wsgi <gvaldap.wsgi>`
-----------------------------
.. automodule:: gvaldap.wsgi
:members:
:py:mod:`settings <gvaldap.settings>`
-------------------------------------
.. automodule:: gvaldap.settings
:py:mod:`base <gvaldap.settings.base>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.base
:members:
:py:mod:`local <gvaldap.settings.local>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.local
:py:mod:`production <gvaldap.settings.production>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.production
:py:mod:`test <gvaldap.settings.test>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: gvaldap.settings.test
:py:mod:`ldapentities` app
==========================
.. automodule:: ldapentities
:py:mod:`admin <ldapenties.admin>`
----------------------------------
.. automodule:: ldapentities.admin
:members:
:py:mod:`models <ldapenties.models>`
------------------------------------
.. automodule:: ldapentities.models
:members:
:py:mod:`ldaptasks` app
=======================
.. automodule:: ldaptasks
:py:mod:`tasks <ldaptasks.tasks>`
---------------------------------
.. automodule:: ldaptasks.tasks
:members:
:undoc-members: