Autogenerate docs for whole package

alan-turing-institute · Sep 20, 2023 · 7b20d16 · 7b20d16
1 parent 237f3a3
commit 7b20d16
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,3 +66,7 @@ def setup(app):  # type: ignore
 
 # is_subproject = True
 # readthedocs_url = "https://rctab.readthedocs.io"
+
+# -- Options for autosummary extension
+
+autosummary_generate = True
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,14 +6,16 @@
 Welcome to rctab-cli's documentation!
 =====================================
 
-.. automodule:: rctab_cli.cli
-    :members:
-
 ..
     .. subprojecttoctree::
        :maxdepth: 2
        :caption: Contents:
 
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   rctab_cli
 
 
 Indices and tables