more documentation

src/docs/beewatch/gui/index.rst

@@ -17,10 +17,11 @@
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
-Template
-==============
+Gui Client
+==========
 
-Template text.
+..  automodule:: beewatch.gui
+    :members:
 
 
 

src/docs/beewatch/index.rst

@@ -18,24 +18,20 @@
 
 
 
-BeeWatch
-========
-
-..  Note::
-    This documentation is in early development.
+BeeWatch Reference
+==================
+This is the documentation of the code.s
 
 ..  toctree::
     :maxdepth: 2
     :caption: Contents:
 
-    /design.rst
-    gui/index.rst
-    server/index.rst
-    pinapi/index.rst
+    /beewatch/gui/index.rst
+    /beewatch/server/index.rst
+    /beewatch/pinapi/index.rst
 
 ..  automodule:: beewatch
     :members:
-    :undoc-members:
 
 
 

src/docs/beewatch/pinapi/index.rst

@@ -17,11 +17,13 @@
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
-Template
-==============
+Gpio Api
+========
 
 Template text.
 
+..  automodule:: beewatch.pinapi
+    :members:
 
 
 

src/docs/beewatch/server/index.rst

@@ -17,12 +17,13 @@
     along with BeeWatch.  If not, see <http://www.gnu.org/licenses/>.
 
 
-Template
-==============
+Server
+======
 
 Template text.
 
-
+..  automodule:: beewatch.server
+    :members:
 
 
 

src/docs/configure.rst

@@ -18,8 +18,8 @@
 
 
 
-HowTo Configuration!
-====================================
+HowTo Configuration
+===================
 This page explains how to configure BeeWatch.
 
 

src/docs/design.rst

@@ -22,7 +22,20 @@ Program Design
 
 This page explains the structure of BeeWatch.
 
+..  Note::
+    This is how i want it to be, not how it is right now. In the current state the core and the server are not separated, the core opens a public server.
 
+Core
+-----
+The Core handles gpio stuff and analyses data. The data can be accessed through a file socket opened by the Core.
+
+Server
+------
+The Server connects to the file socket of the core and serves has extensions for different types of (public) apis. authentication will be implemented using ssl, username/password or both.
+
+Client
+------
+The Client is the front end of BeeWatch. Right now it is a program but I plan a web interface client.
 
 
 

src/docs/getting_started.rst

@@ -25,11 +25,6 @@ Getting Started subheading
 --------------------------
 subyadda
 
-..  toctree::
-    :maxdepth: 2
-    :caption: Contents:
-
-    /includes/free_software.rst
 
 
 

src/docs/index.rst

@@ -37,13 +37,14 @@ BeeWatch aims to help beekeepers understand their beehive. Easily ansewer questi
     :maxdepth: 2
     :caption: Contents:
 
-    inspiration.rst
-    install.rst
-    getting_started.rst
-    beewatch/index.rst
-    configure.rst
-    includes/tellme.rst
-    includes/indicestables.rst
+    /inspiration.rst
+    /install.rst
+    /getting_started.rst
+    /configure.rst
+    /design.rst
+    /beewatch/index.rst
+    /includes/tellme.rst
+    /includes/indicestables.rst
 
 ..  include:: includes/indicestables.rst
 

src/docs/install.rst

@@ -36,7 +36,8 @@ Build the documentation
 -----------------------
 This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This creates the documentation inside 'build/docs/<format>'. The entry point for reading the html version of the docs is `build/docs/html/index.html`.
 
-
+..  Todo::
+    add requirements installation help