Merge branch 'reorganize' into 'master'

Reorganize docs for improved flow and navigation

Closes #14

See merge request !14

.gitignore

@@ -5,12 +5,7 @@
 bin/
 bob.docs.egg-info/
 develop-eggs/
-doc/beat.core/
-doc/beat.cmdline/
-doc/beat.backend.python/
-doc/beat.editor/
-doc/beat.web/
-doc/gridtk
+doc/beat
 doc/extra-intersphinx.txt
 doc/nitpick-exceptions.txt
 eggs/

doc/intro/algorithms.rst → doc/algorithms.rst

@@ -407,7 +407,7 @@ the appropriate amount of data and process it.
 .. _beat-system-algorithms-examples-simple-processor:
 
 Simple autonomous processor algorithm (no parametrization)
-................................................
+..........................................................
 
 At the very minimum, a processor algorithm class must look like this:
 
@@ -442,7 +442,7 @@ The platform will call this method once per block of data available on the
 .. _beat-system-algorithms-examples-simple-evaluator:
 
 Simple autonomous evaluator algorithm (no parametrization)
-................................................
+..........................................................
 
 At the very minimum, a processor algorithm class must look like this:
 
@@ -823,7 +823,7 @@ unsynchronized input (``in3``).
                 view = loader.view('in3', i)
                 data, _, _ = view[0]
                 self.models.append(data['in3'].value)
-
+            return True
 
 
         def process(self, inputs, data_loaders, outputs):

doc/components.rst

+.. vim: set fileencoding=utf-8 :
+
+.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
+.. Contact: beat.support@idiap.ch                                             ..
+..                                                                            ..
+.. This file is part of the beat.docs module of the BEAT platform.            ..
+..                                                                            ..
+.. Commercial License Usage                                                   ..
+.. Licensees holding valid commercial BEAT licenses may use this file in      ..
+.. accordance with the terms contained in a written agreement between you     ..
+.. and Idiap. For further information contact tto@idiap.ch                    ..
+..                                                                            ..
+.. Alternatively, this file may be used under the terms of the GNU Affero     ..
+.. Public License version 3 as published by the Free Software and appearing   ..
+.. in the file LICENSE.AGPL included in the packaging of this file.           ..
+.. The BEAT platform is distributed in the hope that it will be useful, but   ..
+.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
+.. or FITNESS FOR A PARTICULAR PURPOSE.                                       ..
+..                                                                            ..
+.. You should have received a copy of the GNU Affero Public License along     ..
+.. with the BEAT platform. If not, see http://www.gnu.org/licenses/.          ..
+
+.. _beat-components:
+
+===============
+BEAT Components
+===============
+
+This guide details each of BEAT building blocks, their relationships and how
+to use the command-line interface to interact with the BEAT platform
+efficiently.
+
+.. toctree::
+
+    dataformats
+    algorithms
+    libraries
+    databases
+    toolchains
+    experiments
+    plotters
+    plotterparameters
+
+
+
+.. include:: links.rst