Merge branch 'cleanup' into 'master'

Error and unused data cleanup

See merge request !17

doc/algorithms.rst

@@ -1009,7 +1009,7 @@ or by iterating over the list:
 
 Additionally, the following method is usable on a **list of inputs**:
 
-.. py:method:: hasMoreData()
+.. py:method:: InputList.hasMoreData()
 
     Indicates if there is (at least) another block of data to process on some of
     the inputs
@@ -1022,20 +1022,20 @@ Input
 
 Each input provides the following informations:
 
-.. py:attribute:: name
+.. py:attribute:: Input.name
 
     *(string)* Name of the input
 
-.. py:attribute:: data_format
+.. py:attribute:: Input.data_format
 
     *(string)* Data format accepted by the input
 
-.. py:attribute:: data_index
+.. py:attribute:: Input.data_index
 
     *(integer)* Index of the last block of data received on the input (See section
     :ref:`beat-system-algorithms-input-synchronization`)
 
-.. py:attribute:: data
+.. py:attribute:: Input.data
 
     *(object)* The last block of data received on the input
 
@@ -1140,7 +1140,7 @@ have access to additional methods.
 
 The following method is usable on a **list of inputs**:
 
-.. py:method:: next()
+.. py:method:: InputList.next()
 
     Retrieve the next block of data on all the inputs **in a synchronized
     manner**
@@ -1173,11 +1173,11 @@ its inputs, the algorithm would do:
 The following methods are usable on an ``input``, in cases where the algorithm
 doesn't care about the synchronization of some of its inputs:
 
-.. py:method:: hasMoreData()
+.. py:method:: Input.hasMoreData()
 
     Indicates if there is (at least) another block of data available on the input
 
-.. py:method:: next()
+.. py:method:: Input.next()
 
     Retrieve the next block of data
 
@@ -1336,18 +1336,18 @@ Output
 
 Each output provides the following informations:
 
-.. py:attribute:: name
+.. py:attribute:: OutputList.name
 
     *(string)* Name of the output
 
-.. py:attribute:: data_format
+.. py:attribute:: OutputList.data_format
 
     *(string)* Format of the data written on the output
 
 
 And the following method:
 
-.. py:method:: write(data, end_data_index=None)
+.. py:method:: OutputList.write(data, end_data_index=None)
 
     Write a block of data on the output
 

doc/intro/index.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
-======
-
-This guide contains installation instructions, a general introduction to core
-components of the BEAT framework and a brief tutorial that examplifies how to
-build and execute a complete experiment locally.
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-
-.. include:: links.rst
-

doc/intro/nitpick-exceptions.txt

-# Not available in Python 2.7, but ok in Python 3.x
-py:exc TypeError
-py:exc RuntimeError
-py:exc ValueError
-py:exc KeyError
-py:class tuple
-py:class list

doc/links.rst

@@ -5,7 +5,7 @@
 .. _reproducible research: https://reproducibleresearch.net/
 .. _numpy safe-casting rules: http://docs.scipy.org/doc/numpy/reference/generated/numpy.can_cast.html
 .. _zen of python: https://www.python.org/dev/peps/pep-0020/
-.. _json: http://en.wikipedia.org/wiki/JSON
+.. _JSON: http://en.wikipedia.org/wiki/JSON
 .. _beat.env.python27: http://gitlab.idiap.ch/biometric/beat.env.python27
 .. _beat.backend.python: http://gitlab.idiap.ch/biometric/beat.backend.python
 .. _python 2.7: http://www.python.org