Skip to content

Commit 8de6ec7

Browse files
committed
DOC: use autosummary
1 parent e57b674 commit 8de6ec7

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

doc/api.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
API Documentation
22
=================
33

4-
.. automodule:: rtmixer
4+
.. module:: rtmixer
5+
6+
.. autosummary::
7+
:nosignatures:
8+
9+
Mixer
10+
Recorder
11+
MixerAndRecorder
12+
RingBuffer
513

614
.. autoclass:: Mixer
715
:members: play_buffer, play_ringbuffer, actions, cancel, wait, stats,

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
extensions = [
2020
'sphinx.ext.autodoc',
21+
'sphinx.ext.autosummary',
2122
'sphinx.ext.intersphinx',
2223
'sphinx.ext.viewcode',
2324
]

0 commit comments

Comments
 (0)