automatic API documentation
[tiramisu.git] / doc / index.txt
1 .. default-role:: literal
2
3 .. meta::
4
5    :description: configuration management
6    :keywords: config, configuration
7
8 .. title:: tiramisu
9
10 The tasting of `Tiramisu`
11 =========================
12
13 .. image:: tiramisu.jpeg
14    :height: 150px
15
16 `Tiramisu`
17
18     is a cool, refreshing Italian dessert,
19
20     it is also an `options controller tool`_.
21
22 .. _`options controller tool`: http://en.wikipedia.org/wiki/Configuration_management#Overview
23
24
25 It's a pretty small, local (that is, straight on the operating system) options 
26 handler and controller.
27
28 controlling options explanations 
29 --------------------------------------
30
31 .. toctree::
32     :maxdepth: 1
33
34     getting-started
35     config
36     option
37     status
38     consistency
39     error
40     glossary
41     doctest
42
43
44 auto generated library's API
45 --------------------------------
46
47 .. autosummary::
48     :toctree: api
49     :template: module.rst
50
51     tiramisu.option
52     tiramisu.setting
53     tiramisu.config
54     tiramisu.value
55     tiramisu.autolib
56     tiramisu.error
57     
58 Indices and tables
59 ==================
60
61 * :ref:`genindex`
62 * :ref:`modindex`
63 * :ref:`search`
64
65 This work is licensed under a `Creative Commons Attribution-ShareAlike 3.0 Unported License`_.
66
67 .. _`Creative Commons Attribution-ShareAlike 3.0 Unported License`: http://creativecommons.org/licenses/by-sa/3.0/deed.en_US
68
69 .. todolist:: 
70
71
72
73