added autosummary pages

bmcfee · Jul 8, 2016 · 09b62a2 · 09b62a2
1 parent ffac20e
commit 09b62a2
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,6 +31,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',

diff --git a/pumpp/feature/__init__.py b/pumpp/feature/__init__.py
@@ -1,6 +1,21 @@
 #!/usr/bin/env python
 # -*- encoding: utf-8 -*-
-'''Feature extractors'''
+'''
+Feature extractors
+==================
+
+.. autosummary::
+    :toctree: generated/
+
+    FeatureExtractor
+    CQT
+    CQTMag
+    CQTPhaseDiff
+    STFT
+    STFTMag
+    STFTPhaseDiff
+    Mel
+'''
 
 from .base import *
 from .cqt import *

diff --git a/pumpp/task/__init__.py b/pumpp/task/__init__.py
@@ -1,6 +1,19 @@
 #!/usr/bin/env python
 # -*- encoding: utf-8 -*-
-'''Task transformations'''
+'''
+Task transformations
+====================
+.. autosummary::
+    :toctree: generated/
+
+    BaseTaskTransformer
+    BeatTransformer
+    ChordTransformer
+    SimpleChordTransformer
+    VectorTransformer
+    DynamicLabelTransformer
+    StaticLabelTransformer
+'''
 
 from .base import *
 from .chord import *