initial documentation setup
This commit is contained in:
parent
18a9d825f2
commit
821edb64b3
12 changed files with 833 additions and 0 deletions
76
docs/code.rst
Normal file
76
docs/code.rst
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
==================
|
||||
Code documentation
|
||||
==================
|
||||
|
||||
.. index:: Django
|
||||
|
||||
gvafile 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:`gvafile`
|
||||
====================================
|
||||
|
||||
.. automodule:: gvafile
|
||||
|
||||
|
||||
:py:mod:`gvafile.celery`
|
||||
------------------------
|
||||
|
||||
.. automodule:: gvafile.celery
|
||||
:members:
|
||||
|
||||
|
||||
:py:mod:`gvafile.urls`
|
||||
----------------------
|
||||
|
||||
.. automodule:: gvafile.urls
|
||||
|
||||
|
||||
:py:mod:`gvafile.wsgi`
|
||||
----------------------
|
||||
|
||||
.. automodule:: gvafile.wsgi
|
||||
:members:
|
||||
|
||||
|
||||
:py:mod:`gvafile.settings`
|
||||
--------------------------
|
||||
|
||||
.. automodule:: gvafile.settings
|
||||
|
||||
:py:mod:`gvafile.settings.base`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvafile.settings.base
|
||||
:members:
|
||||
|
||||
:py:mod:`gvafile.settings.local`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvafile.settings.local
|
||||
|
||||
:py:mod:`gvafile.settings.production`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvafile.settings.production
|
||||
|
||||
:py:mod:`gvafile.settings.test`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvafile.settings.test
|
||||
|
||||
|
||||
:py:mod:`osusers` app
|
||||
=====================
|
||||
|
||||
.. automodule:: osusers
|
||||
|
||||
:py:mod:`osusers.tasks`
|
||||
-----------------------
|
||||
|
||||
.. automodule:: osusers.tasks
|
||||
:members:
|
||||
:undoc-members:
|
||||
Loading…
Add table
Add a link
Reference in a new issue