Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 19 additions & 0 deletions docs/api/types.md
Original file line number Diff line number Diff line change
@@ -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

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down