diff --git a/docs/api/data_assimilation.rst b/docs/api/data_assimilation.rst new file mode 100644 index 0000000..c1d7e64 --- /dev/null +++ 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 new file mode 100644 index 0000000..f91d3e5 --- /dev/null +++ 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 new file mode 100644 index 0000000..1e3bdbc --- /dev/null +++ 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 new file mode 100644 index 0000000..fff5471 --- /dev/null +++ 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 index 10ce6fc..2e2831d 100644 --- 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 deleted file mode 100644 index a9a6130..0000000 --- a/docs/manual/api.rst +++ /dev/null @@ -1,26 +0,0 @@ -API reference -============= - - -Data Assimilation ------------------ - -.. automodapi:: resmda.data_assimilation - :no-inheritance-diagram: - :no-heading: - - -Reservoir Simulator -------------------- - -.. automodapi:: resmda.reservoir_simulator - :no-inheritance-diagram: - :no-heading: - - -Utilities ---------- - -.. automodapi:: resmda.utils - :no-inheritance-diagram: - :no-heading: diff --git a/docs/manual/index.rst b/docs/manual/index.rst index b0cd901..5590f88 100644 --- a/docs/manual/index.rst +++ b/docs/manual/index.rst @@ -16,4 +16,4 @@ User Guide about installation references - api +