DOC autosummary for api (#42)

* making the autosummary work
owkin · Jan 13, 2023 · 419db51 · 419db51
1 parent 36eb9f1
commit 419db51
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 48 deletions.
diff --git a/docs/source/api/DeseqDataSet.rst b/docs/source/api/DeseqDataSet.rst
diff --git a/docs/source/api/DeseqStats.rst b/docs/source/api/DeseqStats.rst
diff --git a/docs/source/api/grid_search.rst b/docs/source/api/grid_search.rst
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -1,12 +1,16 @@
-PyDESeq2 package
-================
-
-.. toctree::
-   :glob:
-   :maxdepth: 2
-
-   DeseqDataSet
-   DeseqStats
-   grid_search
-   preprocessing
-   utils
+
+PyDESeq2
+========
+
+.. currentmodule:: pydeseq2
+
+
+.. autosummary::
+    :toctree: docstrings
+    :recursive:
+
+    DeseqDataSet.DeseqDataSet
+    DeseqStats.DeseqStats
+    ~utils
+    ~grid_search
+    ~preprocessing
diff --git a/docs/source/api/preprocessing.rst b/docs/source/api/preprocessing.rst
diff --git a/docs/source/api/utils.rst b/docs/source/api/utils.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -41,10 +41,12 @@
     "sphinx_rtd_theme",
     "sphinx.ext.ifconfig",
     "myst_parser",
+    "sphinx.ext.autosummary",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.intersphinx",
 ]
 
+
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
@@ -58,8 +60,12 @@
     "show-inheritance": True,
     "members": True,
 }
+
 autoclass_content = "both"
 autodoc_typehints = "both"
+autosummary_generate = True
+autodoc_member_order = "groupwise"
+autodoc_docstring_signature = True
 
 
 # Napoleon settings