DOC: Use the "autosummary" extension

sfstoolbox · Feb 19, 2019 · 94b79ce · 94b79ce
1 parent 44e17c7
commit 94b79ce
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 66 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -0,0 +1,14 @@
+API Documentation
+=================
+
+.. currentmodule:: sfs
+
+.. autosummary::
+    :toctree:
+
+    array
+    tapering
+    mono
+    time
+    plot
+    util
diff --git a/doc/arrays.rst b/doc/arrays.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -32,6 +32,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',  # support for NumPy-style docstrings
@@ -49,6 +50,8 @@
 autodoc_member_order = 'bysource'
 autodoc_default_flags = ['members', 'undoc-members']
 
+autosummary_generate = ['api']
+
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 napoleon_include_private_with_doc = False

diff --git a/doc/frequency-domain.rst b/doc/frequency-domain.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -6,11 +6,7 @@
 
     installation
     examples/index
-    arrays
-    frequency-domain
-    time-domain
-    plotting
-    utilities
+    api
     references
     contributing
     version-history

diff --git a/doc/plotting.rst b/doc/plotting.rst
diff --git a/doc/time-domain.rst b/doc/time-domain.rst
diff --git a/doc/utilities.rst b/doc/utilities.rst
diff --git a/doc/version-history.rst b/doc/version-history.rst
@@ -1 +1,3 @@
+.. default-role:: py:obj
+
 .. include:: ../NEWS.rst
diff --git a/sfs/array.py b/sfs/array.py
@@ -8,9 +8,6 @@
     plt.rcParams['figure.figsize'] = 8, 4.5  # inch
     plt.rcParams['axes.grid'] = True
 
-.. autoclass:: ArrayData
-   :members: take
-
 """
 from collections import namedtuple
 import numpy as np

diff --git a/sfs/mono/__init__.py b/sfs/mono/__init__.py
@@ -1,4 +1,14 @@
-"""Submodules for monochromatic sound fields."""
+"""Submodules for monochromatic sound fields.
+
+.. autosummary::
+    :toctree:
+
+    drivingfunction
+    source
+    synthesized
+    soundfigure
+
+"""
 from . import drivingfunction
 from . import source
 from . import synthesized

diff --git a/sfs/time/__init__.py b/sfs/time/__init__.py
@@ -1,3 +1,13 @@
+"""Submodules for broadband sound fields.
+
+.. autosummary::
+    :toctree:
+
+    drivingfunction
+    source
+    soundfield
+
+"""
 from . import drivingfunction
 from . import source
-from . import soundfield
+from . import soundfield