Skip to content

Commit 94b79ce

Browse files
committed
DOC: Use the "autosummary" extension
1 parent 44e17c7 commit 94b79ce

File tree

12 files changed

+42
-66
lines changed

12 files changed

+42
-66
lines changed

doc/api.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
API Documentation
2+
=================
3+
4+
.. currentmodule:: sfs
5+
6+
.. autosummary::
7+
:toctree:
8+
9+
array
10+
tapering
11+
mono
12+
time
13+
plot
14+
util

doc/arrays.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

doc/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
# ones.
3333
extensions = [
3434
'sphinx.ext.autodoc',
35+
'sphinx.ext.autosummary',
3536
'sphinx.ext.mathjax',
3637
'sphinx.ext.viewcode',
3738
'sphinx.ext.napoleon', # support for NumPy-style docstrings
@@ -49,6 +50,8 @@
4950
autodoc_member_order = 'bysource'
5051
autodoc_default_flags = ['members', 'undoc-members']
5152

53+
autosummary_generate = ['api']
54+
5255
napoleon_google_docstring = False
5356
napoleon_numpy_docstring = True
5457
napoleon_include_private_with_doc = False

doc/frequency-domain.rst

Lines changed: 0 additions & 19 deletions
This file was deleted.

doc/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@
66

77
installation
88
examples/index
9-
arrays
10-
frequency-domain
11-
time-domain
12-
plotting
13-
utilities
9+
api
1410
references
1511
contributing
1612
version-history

doc/plotting.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

doc/time-domain.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

doc/utilities.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

doc/version-history.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
.. default-role:: py:obj
2+
13
.. include:: ../NEWS.rst

sfs/array.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
plt.rcParams['figure.figsize'] = 8, 4.5 # inch
99
plt.rcParams['axes.grid'] = True
1010
11-
.. autoclass:: ArrayData
12-
:members: take
13-
1411
"""
1512
from collections import namedtuple
1613
import numpy as np

0 commit comments

Comments
 (0)