From 8fc7f5ff6069d2cbf692509c788d230692405a2c Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Tue, 16 Apr 2024 21:25:11 -0600 Subject: [PATCH] [wip] Add docs --- doc/api.rst | 12 ++++++++++++ doc/user-guide/groupby.rst | 7 +++++++ xarray/__init__.py | 3 +-- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index a8f8ea7dd1c..087f666ea72 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -1035,6 +1035,18 @@ Accessors core.accessor_dt.TimedeltaAccessor core.accessor_str.StringAccessor +Grouper Objects +=============== +.. autosummary:: + :toctree: generated/ + + groupers.Grouper + groupers.Resampler + groupers.BinGrouper + groupers.UniqueGrouper + groupers.TimeResampler + groupers.EncodedGroups + Custom Indexes ============== .. autosummary:: diff --git a/doc/user-guide/groupby.rst b/doc/user-guide/groupby.rst index 1ad2d52fc00..5540ad6109f 100644 --- a/doc/user-guide/groupby.rst +++ b/doc/user-guide/groupby.rst @@ -232,3 +232,10 @@ applying your function, and then unstacking the result: stacked = da.stack(gridcell=["ny", "nx"]) stacked.groupby("gridcell").sum(...).unstack("gridcell") + +.. _groupby.groupers: + +Extending GroupBy: Grouper Objects +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +... diff --git a/xarray/__init__.py b/xarray/__init__.py index c8d99bab38c..10e09bbf734 100644 --- a/xarray/__init__.py +++ b/xarray/__init__.py @@ -56,6 +56,7 @@ # `mypy --strict` running in projects that import xarray. __all__ = ( # Sub-packages + "groupers", "testing", "tutorial", # Top-level functions @@ -95,8 +96,6 @@ "unify_chunks", "where", "zeros_like", - # Submodules - "groupers", # Classes "CFTimeIndex", "Context",