From 2366b8d258b52bfc944b0eec49948413d1509e20 Mon Sep 17 00:00:00 2001 From: fritz-smh Date: Mon, 10 Aug 2015 23:23:50 +0200 Subject: [PATCH] update doc --- docs/base.txt | 32 ++++++++++++++++++++++++++++++++ docs/changelog.txt | 2 +- docs/conf.py | 2 +- docs/core.txt | 22 ---------------------- docs/index.txt | 2 +- 5 files changed, 35 insertions(+), 25 deletions(-) create mode 100644 docs/base.txt delete mode 100644 docs/core.txt diff --git a/docs/base.txt b/docs/base.txt new file mode 100644 index 0000000..814ad16 --- /dev/null +++ b/docs/base.txt @@ -0,0 +1,32 @@ +.. _index: + +========== +Brain base +========== + +Purpose +======= + +The **base** brain package is the mandatory part of the Domogik butler brain! It will allow you to : + +* control Domogik (get the sensor values like temperature, control the lights, ...) +* have some basic interaction with the butler +* do some basic mathematics +* make the butler learn some things! + +Dependencies +============ + +There is no dependency. + +Brain configuration +=================== + +There is no configuration option for this package. + +How can I see the this brain package allow me to do ? +===================================================== + +In Domogik administration, just go on the corresponding client and look at the **Brain details** page. + + diff --git a/docs/changelog.txt b/docs/changelog.txt index f3c8837..634a319 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -5,5 +5,5 @@ Changelog 1.0 === -* Package creation +* Package creation (merge of domogik-brain-core and domogik-brain-datatype) diff --git a/docs/conf.py b/docs/conf.py index cb0a116..149f856 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,7 @@ master_doc = 'index' # General information about the project. -project = u'domogik-brain-core' +project = u'domogik-brain-base' copyright = u'2015, Fritz' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/core.txt b/docs/core.txt deleted file mode 100644 index 81ee4e4..0000000 --- a/docs/core.txt +++ /dev/null @@ -1,22 +0,0 @@ -.. _index: - -========== -Brain core -========== - -Purpose -======= - -The *core* brain is, with the *datatype* brain the main part of Domogik butler. This brain package will allow you to interact with the butler for some common tasks. - -Dependencies -============ - -There is no dependency. - -Brain configuration -=================== - -There is no configuration option for this plugin. - - diff --git a/docs/index.txt b/docs/index.txt index e369c3a..398f8f4 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -6,6 +6,6 @@ Table Of Content .. toctree:: - /core + /base /dev /changelog