From 4f574a1224ae9edaad2d1ba5e3f5bd2f310cbf83 Mon Sep 17 00:00:00 2001
From: lkugler <lukas.kugler@gmail.com>
Date: Wed, 17 Jan 2024 19:27:22 +0100
Subject: [PATCH] restructure main api page
---
docs/source/dartwrf.rst | 86 ++++++++++-------------------------------
1 file changed, 20 insertions(+), 66 deletions(-)
diff --git a/docs/source/dartwrf.rst b/docs/source/dartwrf.rst
index b69fef0..056ea2a 100644
--- a/docs/source/dartwrf.rst
+++ b/docs/source/dartwrf.rst
@@ -1,37 +1,31 @@
dartwrf package
===============
-Subpackages
------------
-
-.. toctree::
- :maxdepth: 4
-
- dartwrf.obs
-
-Submodules
-----------
-
-dartwrf.assimilate module
---------------------------------
+Configuration: dartwrf.utils module
+--------------------
-.. automodule:: dartwrf.assimilate
+.. automodule:: dartwrf.utils
:members:
:undoc-members:
:show-inheritance:
-dartwrf.create\_obs\_upfront module
------------------------------------
-.. automodule:: dartwrf.create_obs_upfront
+Job-Submission: dartwrf.workflows module
+------------------------
+
+.. automodule:: dartwrf.workflows
:members:
:undoc-members:
:show-inheritance:
-dartwrf.create\_wbubble\_wrfinput module
-----------------------------------------
-.. automodule:: dartwrf.create_wbubble_wrfinput
+Submodules
+----------
+
+dartwrf.assimilate module
+--------------------------------
+
+.. automodule:: dartwrf.assimilate
:members:
:undoc-members:
:show-inheritance:
@@ -52,30 +46,6 @@ dartwrf.evaluate\_obs\_space module
:undoc-members:
:show-inheritance:
-dartwrf.evaluate\_posterior module
-----------------------------------
-
-.. automodule:: dartwrf.evaluate_posterior
- :members:
- :undoc-members:
- :show-inheritance:
-
-dartwrf.evaluate\_prior module
-------------------------------
-
-.. automodule:: dartwrf.evaluate_prior
- :members:
- :undoc-members:
- :show-inheritance:
-
-dartwrf.exp\_config module
---------------------------
-
-.. automodule:: dartwrf.exp_config
- :members:
- :undoc-members:
- :show-inheritance:
-
dartwrf.prep\_IC\_prior module
------------------------------
@@ -116,22 +86,6 @@ dartwrf.update\_IC module
:undoc-members:
:show-inheritance:
-dartwrf.utils module
---------------------
-
-.. automodule:: dartwrf.utils
- :members:
- :undoc-members:
- :show-inheritance:
-
-dartwrf.workflows module
-------------------------
-
-.. automodule:: dartwrf.workflows
- :members:
- :undoc-members:
- :show-inheritance:
-
dartwrf.wrfinput\_add\_geo module
---------------------------------
@@ -148,10 +102,10 @@ dartwrf.wrfout\_add\_geo module
:undoc-members:
:show-inheritance:
-Module contents
----------------
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
-.. automodule:: dartwrf
- :members:
- :undoc-members:
- :show-inheritance:
+ dartwrf.obs
--
GitLab