From de61c89197504ad11974f0a661b100890ad5dd10 Mon Sep 17 00:00:00 2001 From: Thomas Fillon Date: Wed, 20 Nov 2013 17:37:45 +0100 Subject: [PATCH] Documentation : small updates, put back numpydoc extension for sphinx --- doc/source/api/decoder/index.rst | 16 +++++++++++++++- doc/source/conf.py | 3 ++- doc/source/intro.rst | 2 +- doc/source/related.rst | 2 +- doc/source/tutorial/AnalyzerResult.rst | 2 +- 5 files changed, 20 insertions(+), 5 deletions(-) diff --git a/doc/source/api/decoder/index.rst b/doc/source/api/decoder/index.rst index b9bcdf8..ac081a5 100644 --- 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 87d02f3..51eeba5 100644 --- 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 f89f326..46c6dd9 100644 --- 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 b8123b8..0584be8 100644 --- a/doc/source/related.rst +++ b/doc/source/related.rst @@ -5,7 +5,7 @@ Sponsors and Patners * `CNRS `_ (National Center of Science Research, France) * `Huma-Num `_ (big data equipment for digital humanities, ex TGE Adonis) * `CREM `_ (french National Center of Ethomusicology Research, France) - * `Université Pierre et Marie Curie `_ (UPMC Paris, France) + * `Université Pierre et Marie Curie `_ (UPMC Paris, France) * `ANR `_ (CONTINT 2012 project : DIADEMS) * `MNHN `_ : Museum National d'Histoire Naturelle (Paris, France) diff --git a/doc/source/tutorial/AnalyzerResult.rst b/doc/source/tutorial/AnalyzerResult.rst index f936fca..80d63ed 100644 --- 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 -- 2.39.5