Skip to content

Commit f63e61d

Browse files
authored
docs: add a page linking to the companion packages (#4247)
* docs: add a page linking to the companion packages The zarr-metadata and zarr-indexing docs are already Read the Docs subprojects of zarr-python and resolve under /projects/, but nothing in the main docs pointed at them except two entries buried at the bottom of the API Reference nav, which linked to the standalone *.readthedocs.io domains rather than the /projects/ paths Read the Docs advertises as canonical. Add a top-level "Related Projects" page listing each companion package, surface it as a card on the landing page, repoint the API Reference nav entries at the canonical subproject URLs, and give each subproject a nav link back to the parent docs. The changelog fragment is named for the issue rather than the PR because the upstream PR number is not known yet; rename it to that number when this is opened upstream. Closes #4246 Assisted-by: ClaudeCode:claude-opus-5 * Rename 4246.doc.md to 4247.doc.md * docs: projects -> subprojects * docs: rewire docs references correctly
1 parent 2fc8f82 commit f63e61d

6 files changed

Lines changed: 61 additions & 2 deletions

File tree

‎changes/4247.doc.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Added a "Related Projects" page to the documentation listing the companion
2+
packages developed in this repository — `zarr-metadata` and `zarr-indexing` —
3+
and linked it from the landing page. Links to those packages now use the
4+
canonical `https://zarr.readthedocs.io/projects/...` URLs, and each companion
5+
package's documentation links back to the `zarr-python` docs.

‎docs/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,14 @@ conda install -c conda-forge zarr
5858
which parameters can be used. It assumes that you have an understanding of the
5959
key concepts.
6060

61+
- [:material-package-variant:{ .lg .middle } __Related projects__](subprojects.md)
62+
63+
---
64+
65+
Companion packages developed in the zarr-python repository and released
66+
independently, such as `zarr-metadata` and `zarr-indexing`, plus pointers to
67+
the wider Zarr ecosystem.
68+
6169
- [:material-account-group:{ .lg .middle } __Contributor's Guide__](contributing.md)
6270

6371
---

‎docs/subprojects.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Subprojects
2+
3+
Alongside `zarr` itself, the
4+
[zarr-python repository](https://github.com/zarr-developers/zarr-python) hosts a
5+
small number of companion packages. Each one is developed in the same repository
6+
but versioned, released, and documented independently, so you can depend on it
7+
without taking on `zarr` as a dependency.
8+
9+
<div class="grid cards" markdown>
10+
11+
- [:material-code-json:{ .lg .middle } __zarr-metadata__](https://zarr.readthedocs.io/projects/zarr-metadata/)
12+
13+
---
14+
15+
Spec-defined metadata types, models, and validators for Zarr v2 and v3, with
16+
minimal dependencies. Useful if your software reads or writes Zarr metadata
17+
documents but does not need a full Zarr implementation.
18+
19+
```bash
20+
pip install zarr-metadata
21+
```
22+
23+
- [:material-vector-polyline:{ .lg .middle } __zarr-indexing__](https://zarr.readthedocs.io/projects/zarr-indexing/)
24+
25+
---
26+
27+
Composable, lazy coordinate transforms for Zarr array indexing. Makes the
28+
mapping from requested coordinates to stored coordinates a first-class,
29+
composable value, and resolves which chunks a selection touches.
30+
31+
```bash
32+
pip install zarr-indexing
33+
```
34+
35+
</div>

‎mkdocs.yml‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ nav:
3333
- user-guide/examples/rectilinear_chunks.md
3434
- user-guide/examples/codec_pipeline_performance.md
3535
- user-guide/examples/sharding_coalescing.md
36+
- subprojects.md
3637
- API Reference:
3738
- api/zarr/index.md
3839
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr.abc</code>':
@@ -94,8 +95,12 @@ nav:
9495
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr.testing.utils</code>': api/zarr/testing/utils.md
9596
- '<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> <code>zarr.zeros</code>': api/zarr/functions/zeros.md
9697
- '<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> <code>zarr.zeros_like</code>': api/zarr/functions/zeros_like.md
97-
- 'zarr-metadata ↪': https://zarr-metadata.readthedocs.io/
98-
- 'zarr-indexing ↪': https://zarr-indexing.readthedocs.io/
98+
# The companion packages are Read the Docs subprojects of this one; link
99+
# to the /projects/ paths Read the Docs advertises as canonical rather
100+
# than to their standalone *.readthedocs.io domains, so following one
101+
# keeps the reader on this site's domain.
102+
- 'zarr-metadata ↪': https://zarr.readthedocs.io/projects/zarr-metadata/
103+
- 'zarr-indexing ↪': https://zarr.readthedocs.io/projects/zarr-indexing/
99104
- release-notes.md
100105
- contributing.md
101106
- Blog:

‎packages/zarr-indexing/mkdocs.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ nav:
2626
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr_indexing.messages</code>': api/messages.md
2727
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr_indexing.errors</code>': api/errors.md
2828
- Changelog: https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-indexing/CHANGELOG.md
29+
# This site is a Read the Docs subproject of zarr-python; give readers a way
30+
# back to the parent docs, which list every companion package.
31+
- 'zarr-python ↪': https://zarr.readthedocs.io/
2932

3033
watch:
3134
- src

‎packages/zarr-metadata/mkdocs.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ nav:
2525
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr_metadata.v3.codec</code>': api/v3/codec.md
2626
- '<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> <code>zarr_metadata.v3.data_type</code>': api/v3/data_type.md
2727
- Changelog: https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/CHANGELOG.md
28+
# This site is a Read the Docs subproject of zarr-python; give readers a way
29+
# back to the parent docs, which list every companion package.
30+
- 'zarr-python ↪': https://zarr.readthedocs.io/
2831

2932
watch:
3033
- src

0 commit comments

Comments
 (0)