diff --git a/docs/api/index.md b/docs/api/index.md index 8e6be1058e..ee66313c69 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -48,6 +48,9 @@ The ABC module defines interfaces for extending Zarr: - **[Errors](errors.md)** - Exception classes and error handling - **[Testing](testing.md)** - Utilities for testing Zarr-based code +## Types + +- **[Types](types.md)** - Useful types and classes for zarr function arguments. Any classes listed here are not meant for instantiation. ## Migration and Compatibility diff --git a/docs/api/types.md b/docs/api/types.md new file mode 100644 index 0000000000..d4d41bf5e7 --- /dev/null +++ b/docs/api/types.md @@ -0,0 +1,19 @@ +--- +title: types +--- + +::: zarr.core.array.ShardsLike + options: + show_if_no_docstring: true + show_source: false + +::: zarr.core.array.ShardsConfigParam + options: + show_if_no_docstring: true + show_source: false + +::: zarr.codecs.sharding.ShardingCodecIndexLocation + options: + show_if_no_docstring: true + show_source: false + diff --git a/mkdocs.yml b/mkdocs.yml index c9edf338af..2455f8ee42 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,6 +45,7 @@ nav: - api/registry.md - api/storage.md - api/testing.md + - api/types.md - Async API: api/api_async.md - Sync API: api/api_sync.md - ABC: