[wip] Add docs

pydata · Apr 17, 2024 · 8fc7f5f · 8fc7f5f
1 parent 9338237
commit 8fc7f5f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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",