Skip to content

Commit 2b5fd8f

Browse files
committed
use public dtype module for docs instead of special-casing the core dype module
1 parent 617d3f0 commit 2b5fd8f

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/conf.py

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
issues_github_path = "zarr-developers/zarr-python"
5252

5353
autoapi_dirs = ['../src/zarr']
54-
autoapi_add_toctree_entry = False
54+
autoapi_add_toctree_entry = True
5555
autoapi_generate_api_docs = True
5656
autoapi_member_order = "groupwise"
5757
autoapi_root = "api"
@@ -68,10 +68,7 @@ def skip_submodules(
6868
) -> bool:
6969
# Skip documenting zarr.codecs submodules
7070
# codecs are documented in the main zarr.codecs namespace
71-
# TODO: just document everything instead using this weak case-by-case logic
72-
if what == "module" and name.startswith("zarr.core.dtype."):
73-
skip = False
74-
elif what == "module" and name.startswith("zarr.codecs.") or name.startswith("zarr.core"):
71+
if what == "module" and name.startswith("zarr.codecs.") or name.startswith("zarr.core"):
7572
skip = True
7673
return skip
7774

0 commit comments

Comments
 (0)