gvafile/docs/code.rst

==================
Code documentation
==================

gvafile is implemented as a set of `Celery`_ tasks.

.. _Celery: http://www.celeryproject.org/


The project module :py:mod:`gvafile`
====================================

.. automodule:: gvafile


:py:mod:`celery <gvafile.celery>`
---------------------------------

.. automodule:: gvafile.celery
   :members:


:py:mod:`exceptions <gvafile.exceptions>`
-----------------------------------------

.. automodule:: gvafile.exceptions


:py:mod:`settings <gvafile.settings>`
-------------------------------------

.. automodule:: gvafile.settings
   :members:


:py:mod:`fileservertasks` app
=============================

.. automodule:: fileservertasks


:py:mod:`tasks <fileservertasks.tasks>`
---------------------------------------

.. automodule:: fileservertasks.tasks
   :members:
   :undoc-members:
initial documentation setup 2014-12-25 15:22:33 +01:00			`==================`
			`Code documentation`
			`==================`

remove Django dependencies as they are not used - move settings to gvafile.settings - use gvafile.settings directly without Django support - initialize Celery without Django - remove Django requirements 2015-01-26 17:07:31 +01:00			gvafile is implemented as a set of `Celery`_ tasks.
initial documentation setup 2014-12-25 15:22:33 +01:00
			`.. _Celery: http://www.celeryproject.org/`


			The project module :py:mod:`gvafile`
			`====================================`

			`.. automodule:: gvafile`


adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			:py:mod:`celery <gvafile.celery>`
			`---------------------------------`
initial documentation setup 2014-12-25 15:22:33 +01:00
			`.. automodule:: gvafile.celery`
			`:members:`


adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			:py:mod:`exceptions <gvafile.exceptions>`
			`-----------------------------------------`
implement and document GVAFileException 2014-12-25 21:20:16 +01:00
			`.. automodule:: gvafile.exceptions`


adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			:py:mod:`settings <gvafile.settings>`
			`-------------------------------------`
initial documentation setup 2014-12-25 15:22:33 +01:00
			`.. automodule:: gvafile.settings`
			`:members:`


implement new tasks for website hierarchy - implement tasks fileservertasks.tasks.create_file_website_hierarchy and fileservertasks.tasks.delete_file_website_hierarchy 2015-01-26 17:32:24 +01:00			:py:mod:`fileservertasks` app
			`=============================`
initial documentation setup 2014-12-25 15:22:33 +01:00
adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			`.. automodule:: fileservertasks`
initial documentation setup 2014-12-25 15:22:33 +01:00
remove Django dependencies as they are not used - move settings to gvafile.settings - use gvafile.settings directly without Django support - initialize Celery without Django - remove Django requirements 2015-01-26 17:07:31 +01:00
adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			:py:mod:`tasks <fileservertasks.tasks>`
			`---------------------------------------`
initial documentation setup 2014-12-25 15:22:33 +01:00
adapt documentation to changed package structure 2015-01-19 22:05:57 +01:00			`.. automodule:: fileservertasks.tasks`
initial documentation setup 2014-12-25 15:22:33 +01:00			`:members:`
			`:undoc-members:`