[doc] add py_spectral page
authorPaul Brossier <piem@piem.org>
Fri, 7 Dec 2018 12:09:46 +0000 (13:09 +0100)
committerPaul Brossier <piem@piem.org>
Fri, 7 Dec 2018 12:09:46 +0000 (13:09 +0100)
doc/py_spectral.rst [new file with mode: 0644]
doc/python.rst

diff --git a/doc/py_spectral.rst b/doc/py_spectral.rst
new file mode 100644 (file)
index 0000000..1697041
--- /dev/null
@@ -0,0 +1,34 @@
+.. currentmodule:: aubio
+.. default-domain:: py
+
+.. members of generated classes are not yet documented
+
+Spectral features
+-----------------
+
+This section contains the documentation for:
+
+- :class:`dct`
+- :class:`fft`
+- :class:`filterbank`
+- :class:`mfcc`
+- :class:`pvoc`
+- :class:`specdesc`
+- :class:`tss`
+
+.. autoclass:: dct
+
+.. autoclass:: fft
+  :members:
+
+.. autoclass:: filterbank
+  :members:
+
+.. autoclass:: mfcc
+
+.. autoclass:: pvoc
+  :members:
+
+.. autoclass:: specdesc
+
+.. autoclass:: tss
index 31aa4a1..513b76d 100644 (file)
@@ -30,6 +30,7 @@ Contents
 
    py_datatypes
    py_io
+   py_spectral
    py_utils
    py_examples