doc/iro.rst
author Sandro Knauß <knauss@netzguerilla.net>
Sun, 25 Mar 2012 20:11:34 +0200
branchdevel
changeset 252 d0de2ca7201a
permissions -rw-r--r--
using sphinx for documentation.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
252
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
iro Package
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
===========
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
:mod:`iro` Package
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
.. automodule:: iro.__init__
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
:mod:`config` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    13
--------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
.. automodule:: iro.config
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    17
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
:mod:`error` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
-------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
.. automodule:: iro.error
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
:mod:`install` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    29
---------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
.. automodule:: iro.install
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
:mod:`main` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
.. automodule:: iro.main
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
:mod:`telnumber` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
-----------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
.. automodule:: iro.telnumber
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    51
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
:mod:`validate` Module
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    53
----------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
.. automodule:: iro.validate
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    56
    :members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
    :undoc-members:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
    :show-inheritance:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    59
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
Subpackages
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
-----------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
.. toctree::
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    64
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65
    iro.controller
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
    iro.model
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
    iro.offer
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    68
    iro.view
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69