api: hide zarr.core from api docs

jhamman · Jan 7, 2025 · 7215121 · 7215121
1 parent 12f6012
commit 7215121
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -71,7 +71,7 @@ def skip_submodules(
       ) -> bool:
     # Skip documenting zarr.codecs submodules
     # codecs are documented in the main zarr.codecs namespace
-    if what == "module" and name.startswith("zarr.codecs."):
+    if what == "module" and name.startswith("zarr.codecs.") or name.startswith("zarr.core"):
         skip = True
     return skip
 

diff --git a/src/zarr/core/__init__.py b/src/zarr/core/__init__.py
@@ -1,3 +1,8 @@
+"""
+The ``zarr.core`` module is considered private API and should not be imported
+directly by 3rd-party code.
+"""
+
 from __future__ import annotations
 
 from zarr.core.buffer import Buffer, NDBuffer  # noqa: F401