=========================
Djagios API documentation
=========================

The documentation is build against the dev tree!

How to use the API
==================

The API is generated mostly from the python sources of Djagios and can be used as main source 
of information for developers.

Most of the documentation is straightforward, although some parts of the application have 
specific ways of defining things. This is documented below.


djagios.core.models
-------------------

Each class in Models will define first the methods used then the attributes.
Each attribute has basic explanation and model information defined below.

- relations: FK/m2m, <object>, <related_name>, blank=True/False, null=True/False
- colums: type, length, blank=True/False, null=True/False, unique=True, default=<default>


djagios.templates
-----------------

Here the templates and their functionality are explained

Table of Contents
-----------------

.. toctree::
    :maxdepth: 2

    core/models
    core/exceptions
    common/utils
    templates/default