Merge pull request #1142 from PCMDI/lee1043-patch-2

Update and rename utils.rst to api.rst
PCMDI · Sep 25, 2024 · 837733c · 837733c
2 parents 41a66fa + adf7510
commit 837733c
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,22 @@
+API Reference
+=============
+
+API Functions for Developpers
+-----------------------------
+
+Below is a list of top-level API functions that are available in ``pcmdi_metrics``.
+
+.. autosummary::
+    :toctree: generated/
+
+    check_daily_time_axis
+    check_monthly_time_axis
+    create_land_sea_mask
+    apply_landmask
+    apply_oceanmask
+    regrid
+
+.. automodule:: pcmdi_metrics.utils
+   :members: check_daily_time_axis, check_monthly_time_axis, create_land_sea_mask, apply_landmask, apply_oceanmask, regrid
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/utils.rst b/docs/utils.rst