cleaned docs (#73)

Deltares · Mar 12, 2024 · 74cc608 · 74cc608
1 parent ee638c1
commit 74cc608
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 60 deletions.
diff --git a/docs/ddlpy.rst b/docs/ddlpy.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,20 +1,14 @@
 ddlpy documentation
 ===================
 
+.. mdinclude:: ../README.md
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :titlesonly:
+   :hidden:
 
-   readme
    installation
    usage
    modules
    contributing
-   history
-
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   history
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,7 +1,18 @@
-modules
+Modules
 =========
 
-.. toctree::
-   :maxdepth: 4
+ddlpy.cli module
+----------------
 
-   ddlpy
+.. automodule:: ddlpy.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ddlpy module
+---------------
+
+.. automodule:: ddlpy
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/readme.rst b/docs/readme.rst