Move API outside manual (#5)

tuda-geo · May 29, 2024 · 8222d19 · 8222d19
1 parent bfee468
commit 8222d19
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 27 deletions.
diff --git a/docs/api/data_assimilation.rst b/docs/api/data_assimilation.rst
@@ -0,0 +1,6 @@
+Data Assimilation
+-----------------
+
+.. automodapi:: resmda.data_assimilation
+   :no-inheritance-diagram:
+   :no-heading:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,21 @@
+.. _api:
+
+#############
+API reference
+#############
+
+:Release: |version|
+:Date: |today|
+
+----
+
+.. module:: resmda
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   data_assimilation
+   reservoir_simulator
+   utils
diff --git a/docs/api/reservoir_simulator.rst b/docs/api/reservoir_simulator.rst
@@ -0,0 +1,6 @@
+Reservoir Simulator
+-------------------
+
+.. automodapi:: resmda.reservoir_simulator
+   :no-inheritance-diagram:
+   :no-heading:
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -0,0 +1,6 @@
+Utilities
+---------
+
+.. automodapi:: resmda.utils
+   :no-inheritance-diagram:
+   :no-heading:
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ resmda Documentation
 
    manual/index
    gallery/index
+   api/index
 
 
 **TODOs**

diff --git a/docs/manual/api.rst b/docs/manual/api.rst
diff --git a/docs/manual/index.rst b/docs/manual/index.rst
@@ -16,4 +16,4 @@ User Guide
    about
    installation
    references
-   api
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,4 +16,4 @@ User Guide @@
        about
        installation
        references
-       api