updating docs

drewschaub · Dec 30, 2024 · 3fddad4 · 3fddad4
1 parent ccee17c
commit 3fddad4
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,10 +1,11 @@
 .. protein-design-tools documentation master file, created by
    sphinx-quickstart on Thu May  9 20:22:32 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
 Welcome to Protein Design Tools's documentation!
-================================================
+=================================================
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
@@ -13,8 +14,8 @@ Welcome to Protein Design Tools's documentation!
    modules
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,7 +1,19 @@
-protein_design_tools
-====================
+protein_design_tools package
+============================
+
+.. automodule:: protein_design_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
+   :caption: Submodules:
 
-   protein_design_tools
+   protein_design_tools.core
+   protein_design_tools.io
+   protein_design_tools.metrics
+   protein_design_tools.utils