Merge branch 'dev' of github.com:Parisson/TimeSide into dev

thomasfillon · thomasfillon · commit cb7a9ad496e4 · 2016-02-06T14:29:01.000+01:00
Conflicts:
	.travis.yml
	environment-pinned.yml
diff --git a/doc/source/doc.rst b/doc/source/doc.rst
@@ -1,9 +1,10 @@
 
-API / Documentation
-====================
+Documentation
+==============
 
-* General : http://files.parisson.com/timeside/doc/
+* General documentation : http://files.parisson.com/timeside/doc/
 * Tutorials : http://files.parisson.com/timeside/doc/tutorials/index.html
+* API : http://files.parisson.com/timeside/doc/api/index.html
 * Notebooks : http://nbviewer.ipython.org/github/thomasfillon/Timeside-demos/tree/master/
 * Publications : https://github.com/Parisson/Telemeta-doc
 * Player / UI (old wiki) : https://github.com/Parisson/TimeSide/wiki/Ui-Guide
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -15,8 +15,10 @@ Contents:
    news
    architecture
    processors
+   divein
    install
-   UI
+   ui
+   doc
    Tutorials <tutorials/index>
    API <api/index>
    development
diff --git a/doc/source/tutorials/data_management.rst b/doc/source/tutorials/data_management.rst
@@ -5,10 +5,7 @@
 Data management examples
 ========================
 
-`AnalyzerResult` is the python data structure specific to TimeSide that embeds all the data resulting from a given analyzer processors after a run.
-It is thus the base object to access the analysis results and all the corresponding metadata.
-
-Bellow are examples of use of the Analyzer Result structure.
+TimeSide offers various ways to access to audio data or metadata. `AnalyzerResult` is the python data structure where TimeSide embeds all the data resulting from a given analyzer processors after a run. It is thus the base object to access the analysis results and all the corresponding metadata. Bellow are some examples of use of the AnalyzerResult object and some of its methods.
 
 Usage : AnalyzerResult(data_mode=None, time_mode=None)
 
diff --git a/doc/source/tutorials/frames_stack.rst b/doc/source/tutorials/frames_stack.rst
@@ -2,10 +2,10 @@
    @author: Thomas Fillon
 
 ===============================================
- Running a pipe with previously decoded frames
+ Using the 'stack' (previously decoded frames)
 ===============================================
 
-Example of use of the `stack` argument in :class:`timeside.plugins.decoder.file.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass.
+This is an example of using the `stack` argument in :class:`timeside.plugins.decoder.file.FileDecoder` to run a pipe with previously decoded frames stacked in memory on a second pass.
 
 First, let's import everything and define the audio file source :
 
diff --git a/doc/source/tutorials/index.rst b/doc/source/tutorials/index.rst
@@ -7,6 +7,6 @@ Contents:
    :maxdepth: 2
 
    Quick start <quick_start>
-   Usage of AnalyzerResult <AnalyzerResult>
-   Running a pipe with previously decoded frames <frames_stack>
-   Streaming out encoded audio <Streaming>
+   Data management examples <data_management>
+   Using the 'stack' (previously decoded frames) <frames_stack>
+   Streaming out encoded audio <streaming>
diff --git a/doc/source/tutorials/streaming.rst b/doc/source/tutorials/streaming.rst
diff --git a/doc/source/ui.rst b/doc/source/ui.rst
