From d99ff88a49ba49ab59be64930a278942d868325d Mon Sep 17 00:00:00 2001
From: Tim Stadtmann <tim.stadtmann@rwth-aachen.de>
Date: Fri, 3 Feb 2017 14:54:51 +0100
Subject: [PATCH] Rework structure of HTML-documentation

---
 docs/EV3.rst      | 12 ++++++++++++
 docs/Motor.rst    | 10 ++++++++++
 docs/Sensor.rst   | 10 ++++++++++
 docs/conf.py      |  3 ++-
 docs/examples.rst |  3 +++
 docs/index.rst    | 47 +++++++++++++++++++++++++++++++++++++----------
 docs/readme.rst   | 12 ++++++++++++
 docs/source.rst   | 13 -------------
 8 files changed, 86 insertions(+), 24 deletions(-)
 create mode 100644 docs/EV3.rst
 create mode 100644 docs/Motor.rst
 create mode 100644 docs/Sensor.rst
 create mode 100644 docs/examples.rst
 create mode 100644 docs/readme.rst

diff --git a/docs/EV3.rst b/docs/EV3.rst
new file mode 100644
index 0000000..bb679dc
--- /dev/null
+++ b/docs/EV3.rst
@@ -0,0 +1,12 @@
+.. automodule:: source
+
+.. |br| raw:: html
+   
+   <br />
+EV3
+===
+
+.. autoclass:: EV3
+   :members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
+
+
diff --git a/docs/Motor.rst b/docs/Motor.rst
new file mode 100644
index 0000000..4e89a89
--- /dev/null
+++ b/docs/Motor.rst
@@ -0,0 +1,10 @@
+.. automodule:: source
+
+.. |br| raw:: html
+
+   <br />
+Motor
+=====
+
+.. autoclass:: Motor
+   :members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
diff --git a/docs/Sensor.rst b/docs/Sensor.rst
new file mode 100644
index 0000000..0404ade
--- /dev/null
+++ b/docs/Sensor.rst
@@ -0,0 +1,10 @@
+.. automodule:: source
+
+.. |br| raw:: html
+
+   <br />
+Sensor
+======
+
+.. autoclass:: Sensor
+   :members: reset, setProperties
diff --git a/docs/conf.py b/docs/conf.py
index e09d3c5..1685a35 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -157,7 +157,8 @@ html_theme = 'bootstrap'
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {'navbar_fixed_top': True, 
+			'bootswatch_theme': "readable"}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
diff --git a/docs/examples.rst b/docs/examples.rst
new file mode 100644
index 0000000..b90c0e1
--- /dev/null
+++ b/docs/examples.rst
@@ -0,0 +1,3 @@
+========
+Examples
+========
diff --git a/docs/index.rst b/docs/index.rst
index 32339b8..4ebb311 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,21 +3,48 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Toolbox for controlling Lego Mindstorms EV3 with MATLAB
-=======================================================
+==================================================
+MATLAB Toolbox for controlling Lego Mindstorms EV3 
+==================================================
 
-Contents:
+This MATLAB toolbox was designed to abstract and simplify controlling Lego Mindstorms
+EV3 robots. Via Bluetooth or USB you can read sensor values or control
+your robots' motors in an intuitive way. On a low level (the ##hyperlink## Communication
+layer) you are able to send various commands directly to the brick, while on a high level,
+several classes abstract this behaviour for you. If you want to easily access your EV3 robot,
+these are the classes you will mostly use.
+
+Take a look at the ##link to readme## for installation instructions.
+
+This toolbox is being developed at the RWTH Aachen, Germany, as part of the students' lab
+##hyperlink## 'MATLAB meets Mindstorms'. It is the follow-up of the widely used ##hyperlink## MATLAB NXT Toolbox.
+
+##image##
+
+Contents
+========
+
+Setting up the toolbox
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
-   source
+   readme
+   examples
 
+Toolbox documentation
 
-Indices and tables
-==================
+.. toctree::
+   :maxdepth: 2
+   
+   EV3
+   Motor
+   Sensor
+
+Advanced
+
+.. toctree::
+   :maxdepth: 2
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   
 
diff --git a/docs/readme.rst b/docs/readme.rst
new file mode 100644
index 0000000..ddcfba5
--- /dev/null
+++ b/docs/readme.rst
@@ -0,0 +1,12 @@
+=======
+General
+=======
+
+Installation
+============
+
+Contribution
+============
+
+Licenses
+========
diff --git a/docs/source.rst b/docs/source.rst
index 589e1dd..bb679dc 100644
--- a/docs/source.rst
+++ b/docs/source.rst
@@ -10,16 +10,3 @@ EV3
    :members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
 
 
-Motor
-=====
-
-.. autoclass:: Motor
-   :members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
-
-
-Sensor
-======
-
-.. autoclass:: Sensor
-   :members: reset, setProperties
-
-- 
GitLab