automatic API documentation
authorgwen <gremond@cadoles.com>
Fri, 23 Aug 2013 09:16:26 +0000 (11:16 +0200)
committergwen <gremond@cadoles.com>
Fri, 23 Aug 2013 09:16:26 +0000 (11:16 +0200)
14 files changed:
doc/_templates/module.rst [new file with mode: 0644]
doc/api/tiramisu.autolib.txt [new file with mode: 0644]
doc/api/tiramisu.config.txt [new file with mode: 0644]
doc/api/tiramisu.error.txt [new file with mode: 0644]
doc/api/tiramisu.option.txt [new file with mode: 0644]
doc/api/tiramisu.setting.txt [new file with mode: 0644]
doc/api/tiramisu.value.txt [new file with mode: 0644]
doc/conf.py
doc/doctest.txt [new file with mode: 0644]
doc/getting-started.txt
doc/index.txt
doc/test.txt [deleted file]
tiramisu/config.py
tiramisu/option.py

diff --git a/doc/_templates/module.rst b/doc/_templates/module.rst
new file mode 100644 (file)
index 0000000..d0127bc
--- /dev/null
@@ -0,0 +1,6 @@
+{{ fullname }}
+{{ underline }}
+
+.. automodule:: {{ fullname }}
+   :members:
+   :noindex:   
diff --git a/doc/api/tiramisu.autolib.txt b/doc/api/tiramisu.autolib.txt
new file mode 100644 (file)
index 0000000..6cac1fb
--- /dev/null
@@ -0,0 +1,6 @@
+tiramisu.autolib
+================
+
+.. automodule:: tiramisu.autolib
+   :members:
+   :noindex:   
\ No newline at end of file
diff --git a/doc/api/tiramisu.config.txt b/doc/api/tiramisu.config.txt
new file mode 100644 (file)
index 0000000..e212fb9
--- /dev/null
@@ -0,0 +1,6 @@
+tiramisu.config
+===============
+
+.. automodule:: tiramisu.config
+   :members:
+   :noindex:   
\ No newline at end of file
diff --git a/doc/api/tiramisu.error.txt b/doc/api/tiramisu.error.txt
new file mode 100644 (file)
index 0000000..ce8ce5a
--- /dev/null
@@ -0,0 +1,6 @@
+tiramisu.error
+==============
+
+.. automodule:: tiramisu.error
+   :members:
+   :noindex:   
\ No newline at end of file
diff --git a/doc/api/tiramisu.option.txt b/doc/api/tiramisu.option.txt
new file mode 100644 (file)
index 0000000..50e000d
--- /dev/null
@@ -0,0 +1,6 @@
+tiramisu.option
+===============
+
+.. automodule:: tiramisu.option
+   :members:
+   :noindex:   
\ No newline at end of file
diff --git a/doc/api/tiramisu.setting.txt b/doc/api/tiramisu.setting.txt
new file mode 100644 (file)
index 0000000..259455f
--- /dev/null
@@ -0,0 +1,5 @@
+tiramisu.setting
+================
+
+.. automodule:: tiramisu.setting
+   :members:
diff --git a/doc/api/tiramisu.value.txt b/doc/api/tiramisu.value.txt
new file mode 100644 (file)
index 0000000..64f247c
--- /dev/null
@@ -0,0 +1,5 @@
+tiramisu.value
+==============
+
+.. automodule:: tiramisu.value
+   :members:
index 36aa251..cb97d7a 100644 (file)
@@ -41,16 +41,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'tiramisu'
-copyright = u'2012, gwen'
+copyright = u'2013, tiramisu team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0'
+version = '1'
 # The full version, including alpha/beta/rc tags.
-release = '18'
+release = '1.0RC1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -91,15 +91,7 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
-html_theme_options = {
-    "rightsidebar": "true",
-    "nosidebar": "false",
-    "sidebarbgcolor": "black",
-    "relbarbgcolor": "black",
-    "footerbgcolor": "black"
-    }
-
+html_theme = 'traditional'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -296,3 +288,8 @@ todo_include_todos = True
 
 extlinks = {'api': ('./api/tiramisu.%s', ""),
                 'test': ('./api/test.%s', "")}
+
+
+autosummary_generate = True
+
+
diff --git a/doc/doctest.txt b/doc/doctest.txt
new file mode 100644 (file)
index 0000000..9c7c57e
--- /dev/null
@@ -0,0 +1,19 @@
+Test framework
+==================
+
+
+config APIs
+-----------------
+
+.. automodule:: test.test_config
+    :members:
+
+option APIs
+---------------
+
+
+.. automodule:: test.test_option
+    :members:
+
+
+    
index 1dd0edf..aa77a1e 100644 (file)
@@ -2,26 +2,26 @@
 Getting started
 ==================================
 
-What is Configuration handling ?
+What is options handling ?
 =================================
 
-Due to more and more available configuration options required to set up
-an operating system, it became quite annoying to hand the necessary
-options to where they are actually used and even more annoying to add
-new options. To circumvent these problems the configuration management
-was introduced...
+Due to more and more available options required to set up an operating system, 
+to set up compiler options, vs... it became quite annoying to hand the 
+necessary options to where they are actually used and even more annoying to add 
+new options. To circumvent these problems the configuration management was 
+introduced...
 
 What is Tiramisu ?
 ===================
 
-Tiramisu is yet another configuration handler, wich aims at producing flexible 
-and fast configuration options access. The main advantages are its access rule
-and the fact that the configuration's consistency is preserved at any time, see 
+Tiramisu is an options handler and an options controller, wich aims at 
+producing flexible and fast options access. The main advantages are its acces
+rules and the fact that the whole consistency is preserved at any time, see
 :doc:`consistency`. There is of course type and structure validations, but also 
-validations towards the whole configuration.
+validations towards the whole options.
 
-Last but not least, configuration options can be reached and changed
-according to the access rules from nearly everywhere in your appliance.
+Last but not least, options can be reached and changed according to the access 
+rules from nearly everywhere in your appliance.
 
 Just the facts
 ==============
@@ -44,8 +44,9 @@ named ``tiramisu``.
 Getting started
 -------------------
 
-Configuration option objects can be created in different ways. Let's perform 
-very basic :class:`tiramisu.config.Config` object manipulations:
+Option objects can be created in different ways. Let's perform very basic 
+:class:`~tiramisu.option.Option` and :class:`~tiramisu.config.Config` object 
+manipulations:
 
 ::
 
@@ -70,6 +71,6 @@ So by now, we have
   attribute access way (here `bool`, wich is a boolean option:
   :class:`tiramisu.option.BoolOption()`.
 
-Configuration option objects :class:`tiramisu.config.Config()` are produced at 
-the entry point and then handed down to where they are actually used. This 
-keeps configuration local but available everywhere and consistent.
+So, option objects are produced at the entry point and then handed down to 
+where they are actually used. This keeps options local but available everywhere 
+and consistent.
index ee3ae10..0c793cd 100644 (file)
@@ -17,13 +17,16 @@ The tasting of `Tiramisu`
 
     is a cool, refreshing Italian dessert,
 
-    it is also a `configuration management tool`_.
+    it is also an `options controller tool`_.
 
-.. _`configuration management tool`: http://en.wikipedia.org/wiki/Configuration_management
+.. _`options controller tool`: http://en.wikipedia.org/wiki/Configuration_management#Overview
 
 
-It's a pretty small, local (that is, straight on the operating system)
-configuration handler.
+It's a pretty small, local (that is, straight on the operating system) options 
+handler and controller.
+
+controlling options explanations 
+--------------------------------------
 
 .. toctree::
     :maxdepth: 1
@@ -35,7 +38,22 @@ configuration handler.
     consistency
     error
     glossary
-    test
+    doctest
+
+
+auto generated library's API
+--------------------------------
+
+.. autosummary::
+    :toctree: api
+    :template: module.rst
+
+    tiramisu.option
+    tiramisu.setting
+    tiramisu.config
+    tiramisu.value
+    tiramisu.autolib
+    tiramisu.error
     
 Indices and tables
 ==================
diff --git a/doc/test.txt b/doc/test.txt
deleted file mode 100644 (file)
index 9c7c57e..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-Test framework
-==================
-
-
-config APIs
------------------
-
-.. automodule:: test.test_config
-    :members:
-
-option APIs
----------------
-
-
-.. automodule:: test.test_option
-    :members:
-
-
-    
index 269493e..7fa9e9a 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"pretty small and local configuration management tool"
+"options handler global entry point"
 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
 #
 # This program is free software; you can redistribute it and/or modify
index 1a36272..383c644 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"option types and option description for the configuration management"
+"option types and option description"
 # Copyright (C) 2012-2013 Team tiramisu (see AUTHORS for all contributors)
 #
 # This program is free software; you can redistribute it and/or modify