Autosummary generates documentation for modules

As well as "summary" tables of members
computational-psychology · Mar 9, 2023 · 1285041 · 1285041
1 parent 5f2b51a
commit 1285041
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -38,7 +38,11 @@ launch_buttons:
 sphinx:
   extra_extensions:
     - sphinx.ext.intersphinx
+    - sphinx.ext.autosummary        # generate summary tables of functions in modules
+
   config:
+    autosummary_generate: True  # Actually use sphinx.ext.autosummary
+    add_module_names: False         # Don't include module names in autosummary tables
     intersphinx_mapping:
         numpy [stable]:
           - 'https://numpy.org/doc/stable/'

diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -1 +1,12 @@
 # `stimupy` API
+```{eval-rst}
+.. autosummary::
+   :toctree: _api
+   :recursive:
+
+   stimupy.components
+   stimupy.illusions
+   stimupy.noises
+   stimupy.utils
+   stimupy.papers
+```