From adf7510808531e9a7eaea5c254670efd1416f494 Mon Sep 17 00:00:00 2001 From: Jiwoo Lee Date: Tue, 24 Sep 2024 22:51:57 -0700 Subject: [PATCH] Update and rename utils.rst to api.rst --- docs/api.rst | 22 ++++++++++++++++++++++ docs/utils.rst | 9 --------- 2 files changed, 22 insertions(+), 9 deletions(-) create mode 100644 docs/api.rst delete mode 100644 docs/utils.rst diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 000000000..b59801096 --- /dev/null +++ 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 deleted file mode 100644 index 45749ab04..000000000 --- a/docs/utils.rst +++ /dev/null @@ -1,9 +0,0 @@ -***** -Utils -***** - - -.. 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: