diff --git a/docs/source/api/DeseqDataSet.rst b/docs/source/api/DeseqDataSet.rst deleted file mode 100644 index a50de9d4..00000000 --- a/docs/source/api/DeseqDataSet.rst +++ /dev/null @@ -1,8 +0,0 @@ -pydeseq2.DeseqDataSet module -============================ - -.. automodule:: pydeseq2.DeseqDataSet - :members: - :undoc-members: - :show-inheritance: - diff --git a/docs/source/api/DeseqStats.rst b/docs/source/api/DeseqStats.rst deleted file mode 100644 index 1e4f61f6..00000000 --- a/docs/source/api/DeseqStats.rst +++ /dev/null @@ -1,7 +0,0 @@ -pydeseq2.DeseqStats module -========================== - -.. automodule:: pydeseq2.DeseqStats - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/grid_search.rst b/docs/source/api/grid_search.rst deleted file mode 100644 index 832119af..00000000 --- a/docs/source/api/grid_search.rst +++ /dev/null @@ -1,7 +0,0 @@ -pydeseq2.grid\_search module -============================ - -.. automodule:: pydeseq2.grid_search - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index 52ff8d97..c0336bfb 100644 --- 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 \ No newline at end of file diff --git a/docs/source/api/preprocessing.rst b/docs/source/api/preprocessing.rst deleted file mode 100644 index 598eea35..00000000 --- a/docs/source/api/preprocessing.rst +++ /dev/null @@ -1,7 +0,0 @@ -pydeseq2.preprocessing module -============================= - -.. automodule:: pydeseq2.preprocessing - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/utils.rst b/docs/source/api/utils.rst deleted file mode 100644 index 73c34ad4..00000000 --- a/docs/source/api/utils.rst +++ /dev/null @@ -1,7 +0,0 @@ -pydeseq2.utils module -===================== - -.. automodule:: pydeseq2.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index f8f2a0d5..e9881ef6 100644 --- 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