# 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.viewcode', 'sphinx.ext.autodoc']
+extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc',
+ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx']
+
+autodoc_member_order = 'groupwise'
+
+intersphinx_mapping = {
+ 'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+ }
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
--- /dev/null
+.. make sure our default-domain is python here
+.. default-domain:: py
+
+.. set current module
+.. currentmodule:: aubio
+
+..
+ we follow numpy type docstrings, see:
+ https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+
+Python documentation
+====================
+
+
+.. midiconv.py
+
+.. autofunction:: note2midi
+
+.. autofunction:: midi2note
+
+.. autofunction:: freq2note
+
+.. autofunction:: note2freq
+
+.. slicing.py
+
+.. autofunction:: slice_source_at_stamps