update doc

domogik · Aug 10, 2015 · 2366b8d · 2366b8d
1 parent dc78711
commit 2366b8d
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 25 deletions.
diff --git a/docs/base.txt 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
@@ -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
@@ -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
diff --git a/docs/index.txt b/docs/index.txt
@@ -6,6 +6,6 @@ Table Of Content
 
 .. toctree::
 
-    /core
+    /base
     /dev
     /changelog