add initial documentation files
This commit is contained in:
parent
9de85824d1
commit
c84b6c8fc5
13 changed files with 883 additions and 0 deletions
82
docs/code.rst
Normal file
82
docs/code.rst
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
==================
|
||||
Code documentation
|
||||
==================
|
||||
|
||||
.. index:: Django
|
||||
|
||||
gvamysql 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:`gvamysql`
|
||||
=====================================
|
||||
|
||||
.. automodule:: gvamysql
|
||||
|
||||
|
||||
:py:mod:`gvamysql.celery`
|
||||
-------------------------
|
||||
|
||||
.. automodule:: gvamysql.celery
|
||||
:members:
|
||||
|
||||
|
||||
:py:mod:`gvamysql.urls`
|
||||
-----------------------
|
||||
|
||||
.. automodule:: gvamysql.urls
|
||||
|
||||
|
||||
:py:mod:`gvamysql.exceptions`
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: gvamysql.exceptions
|
||||
|
||||
|
||||
:py:mod:`gvamysql.wsgi`
|
||||
-----------------------
|
||||
|
||||
.. automodule:: gvamysql.wsgi
|
||||
:members:
|
||||
|
||||
|
||||
:py:mod:`gvamysql.settings`
|
||||
---------------------------
|
||||
|
||||
.. automodule:: gvamysql.settings
|
||||
|
||||
:py:mod:`gvamysql.settings.base`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvamysql.settings.base
|
||||
:members:
|
||||
|
||||
:py:mod:`gvamysql.settings.local`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvamysql.settings.local
|
||||
|
||||
:py:mod:`gvamysql.settings.production`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvamysql.settings.production
|
||||
|
||||
:py:mod:`gvamysql.settings.test`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. automodule:: gvamysql.settings.test
|
||||
|
||||
|
||||
:py:mod:`mysqltasks` app
|
||||
========================
|
||||
|
||||
.. automodule:: mysqltasks
|
||||
|
||||
:py:mod:`mysqltasks.tasks`
|
||||
--------------------------
|
||||
|
||||
.. automodule:: mysqltasks.tasks
|
||||
:members:
|
||||
:undoc-members:
|
||||
Loading…
Add table
Add a link
Reference in a new issue