Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update and rename utils.rst to api.rst #1142

Merged
merged 1 commit into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -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:
9 changes: 0 additions & 9 deletions docs/utils.rst

This file was deleted.

Loading