From 0db7ef72a6c5e904ce91251e87ed63ae45035682 Mon Sep 17 00:00:00 2001 From: gwen Date: Fri, 23 Aug 2013 11:16:26 +0200 Subject: [PATCH] automatic API documentation --- doc/_templates/module.rst | 6 ++++++ doc/api/tiramisu.autolib.txt | 6 ++++++ doc/api/tiramisu.config.txt | 6 ++++++ doc/api/tiramisu.error.txt | 6 ++++++ doc/api/tiramisu.option.txt | 6 ++++++ doc/api/tiramisu.setting.txt | 5 +++++ doc/api/tiramisu.value.txt | 5 +++++ doc/conf.py | 21 +++++++++------------ doc/{test.txt => doctest.txt} | 0 doc/getting-started.txt | 35 ++++++++++++++++++----------------- doc/index.txt | 28 +++++++++++++++++++++++----- tiramisu/config.py | 2 +- tiramisu/option.py | 2 +- 13 files changed, 92 insertions(+), 36 deletions(-) create mode 100644 doc/_templates/module.rst create mode 100644 doc/api/tiramisu.autolib.txt create mode 100644 doc/api/tiramisu.config.txt create mode 100644 doc/api/tiramisu.error.txt create mode 100644 doc/api/tiramisu.option.txt create mode 100644 doc/api/tiramisu.setting.txt create mode 100644 doc/api/tiramisu.value.txt rename doc/{test.txt => doctest.txt} (100%) diff --git a/doc/_templates/module.rst b/doc/_templates/module.rst new file mode 100644 index 0000000..d0127bc --- /dev/null +++ b/doc/_templates/module.rst @@ -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 index 0000000..6cac1fb --- /dev/null +++ b/doc/api/tiramisu.autolib.txt @@ -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 index 0000000..e212fb9 --- /dev/null +++ b/doc/api/tiramisu.config.txt @@ -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 index 0000000..ce8ce5a --- /dev/null +++ b/doc/api/tiramisu.error.txt @@ -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 index 0000000..50e000d --- /dev/null +++ b/doc/api/tiramisu.option.txt @@ -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 index 0000000..259455f --- /dev/null +++ b/doc/api/tiramisu.setting.txt @@ -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 index 0000000..64f247c --- /dev/null +++ b/doc/api/tiramisu.value.txt @@ -0,0 +1,5 @@ +tiramisu.value +============== + +.. automodule:: tiramisu.value + :members: diff --git a/doc/conf.py b/doc/conf.py index 36aa251..cb97d7a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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/test.txt b/doc/doctest.txt similarity index 100% rename from doc/test.txt rename to doc/doctest.txt diff --git a/doc/getting-started.txt b/doc/getting-started.txt index 1dd0edf..aa77a1e 100644 --- a/doc/getting-started.txt +++ b/doc/getting-started.txt @@ -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 rules -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 access +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. diff --git a/doc/index.txt b/doc/index.txt index ee3ae10..0c793cd 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -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/tiramisu/config.py b/tiramisu/config.py index 269493e..7fa9e9a 100644 --- a/tiramisu/config.py +++ b/tiramisu/config.py @@ -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 diff --git a/tiramisu/option.py b/tiramisu/option.py index 1a36272..383c644 100644 --- a/tiramisu/option.py +++ b/tiramisu/option.py @@ -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