Doc(Spectrogram): add documentation on parameters

diff --git a/doc/source/api/analyzer/analyzers.rst b/doc/source/api/analyzer/analyzers.rst
index 7d6e524e69909c33327f2baddde3454071d6a4e1..3061c55a01162ff803845a65b45db9c56f5e1679 100644 (file)
--- a/doc/source/api/analyzer/analyzers.rst
+++ b/doc/source/api/analyzer/analyzers.rst
@@ -21,53 +21,67 @@ Level
    :undoc-members:
    :show-inheritance:
 
+Other Analyzers
+===============
+
+Spectrogram
+-----------
+.. automodule:: timeside.analyzer.spectrogram
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+
+External librairies
+===================
 
 Aubio
-=====
+-----
 **aubio** is a tool designed for the extraction of annotations from audio signals. Its features include segmenting a sound file before each of its attacks, performing pitch detection, tapping the beat and producing midi streams from live audio.
 See http://aubio.org/
 
 
 Aubio Melenergy
----------------
-.. automodule:: timeside.analyzer.aubio.aubio_melenergy
+~~~~~~~~~~~~~~~
+.. automodule:: timeside.analyzer.externals.aubio_melenergy
    :members:
    :undoc-members:
    :show-inheritance:
 
 
 aubio_mfcc
-----------
-.. automodule:: timeside.analyzer.aubio.aubio_mfcc
+~~~~~~~~~~
+.. automodule:: timeside.analyzer.externals.aubio_mfcc
    :members:
    :undoc-members:
    :show-inheritance:
 
 aubio_pitch
------------
-.. automodule:: timeside.analyzer.aubio.aubio_pitch
+~~~~~~~~~~~
+.. automodule:: timeside.analyzer.externals.aubio_pitch
    :members:
    :undoc-members:
    :show-inheritance:
 
 aubio_specdesc
---------------
-.. automodule:: timeside.analyzer.aubio.aubio_specdesc
+~~~~~~~~~~~~~~
+.. automodule:: timeside.analyzer.externals.aubio_specdesc
    :members:
    :undoc-members:
    :show-inheritance:
 
 aubio_temporal
---------------
-.. automodule:: timeside.analyzer.aubio.aubio_temporal  
+~~~~~~~~~~~~~~
+.. automodule:: timeside.analyzer.externals.aubio_temporal  
    :members:
    :undoc-members:
    :show-inheritance:
 
 
 Yaafe
-=====
-.. automodule:: timeside.analyzer.yaafe
+-----
+.. automodule:: timeside.analyzer.externals.yaafe
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/timeside/analyzer/spectrogram.py b/timeside/analyzer/spectrogram.py
index aba1a780c0014b149c64179a0c20b0d1f8606ae4..10a745abf5546ff88bf5f4f556896916a10d3d8b 100644 (file)
--- a/timeside/analyzer/spectrogram.py
+++ b/timeside/analyzer/spectrogram.py
@@ -33,11 +33,23 @@ import numpy as np
 class Spectrogram(Analyzer):
     """Spectrogram analyzer
 
+    Parameters
+    ----------
+    input_blocksize : int, optional
+        Blocksize of the input signal, default to 2048
+    input_stepsize : str, optional
+        The second parameter, default to half blocksize.
+    fft_size : int, optional
+        The size of the fft, default to blocksize.
+
+    Examples
+    --------
+
     >>> import timeside
     >>> from timeside.tools.data_samples import samples as ts_samples
     >>> audio_source = ts_samples['sweep.wav']
     >>> decoder = timeside.decoder.file.FileDecoder(uri=audio_source)
-    >>> spectrogram = Spectrogram(input_blocksize=2048, input_stepsize=1024)
+    >>> spectrogram = timeside.analyzer.spectrogram.Spectrogram(input_blocksize=2048, input_stepsize=1024)
     >>> pipe = (decoder | spectrogram)
     >>> pipe.run()