Documentation : small updates, put back numpydoc extension for sphinx

diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst
index b9bcdf8de62044f62ff734645374f06c3a749718..ac081a5404d7e6430796e5c3895ef5b308988f58 100644 (file)
--- a/doc/source/api/decoder/index.rst
+++ b/doc/source/api/decoder/index.rst
@@ -7,6 +7,20 @@ Decoder package
    :maxdepth: 2
 
 .. automodule:: timeside.decoder.core
+   
+
+File Decoder
+===========
+
+.. autoclass:: FileDecoder
    :members:
+   :undoc-members:
+   :show-inheritance:
 
-   
+Array Decoder
+=============
+
+.. autoclass:: ArrayDecoder
+   :members:
+   :undoc-members:
+   :show-inheritance:

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 87d02f3e79c2a4d8c26424b98e47f44a996a714b..51eeba5d510174c8db9d4b9192d2df92ad64911e 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -26,12 +26,13 @@ sys.path.insert(0, os.path.abspath('../../'))
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'numpydoc']
 
 doctest_path = os.path.abspath('../../')
 
 
 autodoc_default_flags = 'show-inheritance'
+autoclass_content = 'both'
 
 #autosummary_generate = True
 numpydoc_show_class_members = False

diff --git a/doc/source/intro.rst b/doc/source/intro.rst
index f89f326b6fb5e4be956f0d5d0459c8cee91dbe64..46c6dd95782ffeb61de3327dd4c991f51a796c17 100644 (file)
--- a/doc/source/intro.rst
+++ b/doc/source/intro.rst
@@ -3,7 +3,7 @@ TimeSide : open web audio processing framework
 ==============================================
 
 .. image:: https://secure.travis-ci.org/yomguy/TimeSide.png?branch=master
-    :target: http://travis-ci.org/yomguy/TimeSide/
+    :target: https://travis-ci.org/yomguy/TimeSide/
 
 TimeSide is a set of python components enabling audio analysis, imaging, transcoding and streaming. Its high-level API has been designed to enable complex processing on big media data corpus. Its simple plugin architecture can be adapted to various usecases.
 

diff --git a/doc/source/related.rst b/doc/source/related.rst
index b8123b8a334afe0cbf739b0c5044ac656bdc7180..0584be88fdc2ac6036949fc9d9367453a564a8cb 100644 (file)
--- a/doc/source/related.rst
+++ b/doc/source/related.rst
@@ -5,7 +5,7 @@ Sponsors and Patners
     * `CNRS <http://www.cnrs.fr>`_ (National Center of Science Research, France)
     * `Huma-Num <http://www.huma-num.fr/>`_ (big data equipment for digital humanities, ex TGE Adonis)
     * `CREM <http://www.crem-cnrs.fr>`_ (french National Center of Ethomusicology Research, France)
-    * `Université Pierre et Marie Curie <http://www-upmc.fr>`_ (UPMC Paris, France)
+    * `Université Pierre et Marie Curie <http://www.upmc.fr>`_ (UPMC Paris, France)
     * `ANR <http://www.agence-nationale-recherche.fr/>`_ (CONTINT 2012 project : DIADEMS)
     * `MNHN <http://www.mnhn.fr>`_ : Museum National d'Histoire Naturelle (Paris, France)
 

diff --git a/doc/source/tutorial/AnalyzerResult.rst b/doc/source/tutorial/AnalyzerResult.rst
index f936fcab0d1927956b88eac5bcba3e697715f622..80d63ed97802dafa11e35c18dcaba0fd0491902a 100644 (file)
--- a/doc/source/tutorial/AnalyzerResult.rst
+++ b/doc/source/tutorial/AnalyzerResult.rst
@@ -95,7 +95,7 @@ Event
 DataObject(value=array([], dtype=float64), time=array([], dtype=float64))
 
 Specification of data_mode
-=========================
+==========================
 Two different data_mode can be specified :
 
 - 'value' : Data are returned as numpy Array of arbitrary type