[doc] start adding autodoc to sphinx documents
authorPaul Brossier <piem@piem.org>
Tue, 30 Oct 2018 13:32:51 +0000 (14:32 +0100)
committerPaul Brossier <piem@piem.org>
Tue, 30 Oct 2018 13:32:51 +0000 (14:32 +0100)
doc/conf.py
doc/index.rst
doc/python.rst [new file with mode: 0644]

index 4b5a58f..7d491b0 100644 (file)
@@ -29,7 +29,14 @@ from this_version import get_aubio_version
 
 # 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']
index 4fc80de..5581f73 100644 (file)
@@ -70,6 +70,7 @@ Content
 
    installing
    python_module
+   python
    cli
    develop
    about
diff --git a/doc/python.rst b/doc/python.rst
new file mode 100644 (file)
index 0000000..89d607a
--- /dev/null
@@ -0,0 +1,27 @@
+.. 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