From 7215121b504eefd57e3e296abd1ed8eddefccd1d Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Tue, 7 Jan 2025 15:38:43 -0800 Subject: [PATCH] api: hide zarr.core from api docs --- docs/conf.py | 2 +- src/zarr/core/__init__.py | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2a93e61d3e..8410b9b0b3 100644 --- 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 index cbacfe3422..03a108dbbf 100644 --- 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