DOC: Put autosummaries in "Overview" boxes

mgeier · mgeier · commit c6262b7f6f46 · 2022-07-19T18:50:21.000+02:00
diff --git a/doc/api/checking-hardware.rst b/doc/api/checking-hardware.rst
@@ -3,14 +3,16 @@ Checking Available Hardware
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
-
-   query_devices
-   DeviceList
-   query_hostapis
-   check_input_settings
-   check_output_settings
+.. topic:: Overview
+
+   .. autosummary::
+      :nosignatures:
+   
+      query_devices
+      DeviceList
+      query_hostapis
+      check_input_settings
+      check_output_settings
 
 .. autofunction:: query_devices
 
diff --git a/doc/api/convenience-functions.rst b/doc/api/convenience-functions.rst
@@ -3,16 +3,18 @@ Convenience Functions using NumPy Arrays
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
-
-   play
-   rec
-   playrec
-   wait
-   stop
-   get_status
-   get_stream
+.. topic:: Overview
+
+   .. autosummary::
+      :nosignatures:
+   
+      play
+      rec
+      playrec
+      wait
+      stop
+      get_status
+      get_stream
 
 .. autofunction:: play
 
diff --git a/doc/api/expert-mode.rst b/doc/api/expert-mode.rst
@@ -3,13 +3,15 @@ Expert Mode
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
+.. topic:: Overview
 
-   _initialize
-   _terminate
-   _split
-   _StreamBase
+   .. autosummary::
+      :nosignatures:
+   
+      _initialize
+      _terminate
+      _split
+      _StreamBase
 
 .. autofunction:: _initialize
 
diff --git a/doc/api/misc.rst b/doc/api/misc.rst
@@ -3,15 +3,17 @@ Miscellaneous
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
-
-   sleep
-   get_portaudio_version
-   CallbackFlags
-   CallbackStop
-   CallbackAbort
-   PortAudioError
+.. topic:: Overview
+
+   .. autosummary::
+      :nosignatures:
+   
+      sleep
+      get_portaudio_version
+      CallbackFlags
+      CallbackStop
+      CallbackAbort
+      PortAudioError
 
 .. autofunction:: sleep
 
diff --git a/doc/api/module-defaults.rst b/doc/api/module-defaults.rst
@@ -3,10 +3,5 @@ Module-wide Default Settings
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
-
-   default
-
 .. autoclass:: default
    :members:
diff --git a/doc/api/platform-specific-settings.rst b/doc/api/platform-specific-settings.rst
@@ -3,12 +3,14 @@ Platform-specific Settings
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
+.. topic:: Overview
 
-   AsioSettings
-   CoreAudioSettings
-   WasapiSettings
+   .. autosummary::
+      :nosignatures:
+   
+      AsioSettings
+      CoreAudioSettings
+      WasapiSettings
 
 .. autoclass:: AsioSettings
 
diff --git a/doc/api/raw-streams.rst b/doc/api/raw-streams.rst
@@ -3,12 +3,14 @@ Raw Streams
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
+.. topic:: Overview
 
-   RawStream
-   RawInputStream
-   RawOutputStream
+   .. autosummary::
+      :nosignatures:
+   
+      RawStream
+      RawInputStream
+      RawOutputStream
 
 .. autoclass:: RawStream
    :members: read, write
diff --git a/doc/api/streams.rst b/doc/api/streams.rst
@@ -3,12 +3,14 @@ Streams using NumPy Arrays
 
 .. currentmodule:: sounddevice
 
-.. autosummary::
-   :nosignatures:
+.. topic:: Overview
 
-   Stream
-   InputStream
-   OutputStream
+   .. autosummary::
+      :nosignatures:
+   
+      Stream
+      InputStream
+      OutputStream
 
 .. autoclass:: Stream
    :members:
