Merge pull request #29 from bmcfee/docs

Docs
bmcfee · Feb 22, 2017 · 2869c00 · 2869c00
2 parents bfcbddf + 7b3bc6f
commit 2869c00
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 10 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -10,3 +10,7 @@
 
 .. automodule:: pumpp.task
     :members:
+
+.. automodule:: pumpp.sampler
+    :members:
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,6 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'numpydoc',
 ]
@@ -57,14 +56,13 @@
 
 # General information about the project.
 project = 'pumpp'
-copyright = '2016, Brian McFee'
+copyright = '2016-2017, Brian McFee'
 author = 'Brian McFee'
 
 import mock
 MOCK_MODULES = ['numpy', 'scipy', 'scipy.sparse',
                 'sklearn', 'sklearn.preprocessing',
-                'mir_eval',
-                'jams', 'librosa']
+                'mir_eval', 'jams', 'librosa', 'librosa.feature']
 sys.modules.update((mod_name, mock.Mock()) for mod_name in MOCK_MODULES)
 
 # The version info for the project you're documenting, acts as replacement for
@@ -307,8 +305,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python': ('http://docs.python.org/', None),
-                       'numpy': ('http://docs.scipy.org/doc/numpy/', None),
-                       'librosa': ('http://librosa.github.io/librosa/', None),
-                       'jams': ('http://jams.readthedocs.io/en/latest/', None)}
-
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+                       'librosa': ('https://librosa.github.io/librosa/', None),
+                       'jams': ('https://jams.readthedocs.io/en/latest/', None)}
diff --git a/pumpp/sampler.py b/pumpp/sampler.py
@@ -1,11 +1,20 @@
 #!/usr/bin/env python
 # -*- encoding: utf-8 -*-
-'''Data subsampling'''
+'''
+Data subsampling
+================
+.. autosummary::
+    :toctree: generated/
+
+    Sampler
+'''
 
 from itertools import count
 
 import numpy as np
 
+__all__ = ['Sampler']
+
 
 class Sampler(object):
     '''Generate samples from a pumpp data dict.

diff --git a/pumpp/task/__init__.py b/pumpp/task/__init__.py
@@ -10,6 +10,7 @@
     BeatTransformer
     ChordTransformer
     SimpleChordTransformer
+    ChordTagTransformer
     VectorTransformer
     DynamicLabelTransformer
     StaticLabelTransformer