diff --git a/changes/4247.doc.md b/changes/4247.doc.md new file mode 100644 index 0000000000..6dbca1d3d6 --- /dev/null +++ b/changes/4247.doc.md @@ -0,0 +1,5 @@ +Added a "Related Projects" page to the documentation listing the companion +packages developed in this repository — `zarr-metadata` and `zarr-indexing` — +and linked it from the landing page. Links to those packages now use the +canonical `https://zarr.readthedocs.io/projects/...` URLs, and each companion +package's documentation links back to the `zarr-python` docs. diff --git a/docs/index.md b/docs/index.md index ee4098a8ea..eb3b6a5000 100644 --- a/docs/index.md +++ b/docs/index.md @@ -58,6 +58,14 @@ conda install -c conda-forge zarr which parameters can be used. It assumes that you have an understanding of the key concepts. +- [:material-package-variant:{ .lg .middle } __Related projects__](subprojects.md) + + --- + + Companion packages developed in the zarr-python repository and released + independently, such as `zarr-metadata` and `zarr-indexing`, plus pointers to + the wider Zarr ecosystem. + - [:material-account-group:{ .lg .middle } __Contributor's Guide__](contributing.md) --- diff --git a/docs/subprojects.md b/docs/subprojects.md new file mode 100644 index 0000000000..1903f759d2 --- /dev/null +++ b/docs/subprojects.md @@ -0,0 +1,35 @@ +# Subprojects + +Alongside `zarr` itself, the +[zarr-python repository](https://github.com/zarr-developers/zarr-python) hosts a +small number of companion packages. Each one is developed in the same repository +but versioned, released, and documented independently, so you can depend on it +without taking on `zarr` as a dependency. + +
zarr.abc':
@@ -94,8 +95,12 @@ nav:
- ' zarr.testing.utils': api/zarr/testing/utils.md
- ' zarr.zeros': api/zarr/functions/zeros.md
- ' zarr.zeros_like': api/zarr/functions/zeros_like.md
- - 'zarr-metadata ↪': https://zarr-metadata.readthedocs.io/
- - 'zarr-indexing ↪': https://zarr-indexing.readthedocs.io/
+ # The companion packages are Read the Docs subprojects of this one; link
+ # to the /projects/ paths Read the Docs advertises as canonical rather
+ # than to their standalone *.readthedocs.io domains, so following one
+ # keeps the reader on this site's domain.
+ - 'zarr-metadata ↪': https://zarr.readthedocs.io/projects/zarr-metadata/
+ - 'zarr-indexing ↪': https://zarr.readthedocs.io/projects/zarr-indexing/
- release-notes.md
- contributing.md
- Blog:
diff --git a/packages/zarr-indexing/mkdocs.yml b/packages/zarr-indexing/mkdocs.yml
index d7261f32e1..43a5ea5b4c 100644
--- a/packages/zarr-indexing/mkdocs.yml
+++ b/packages/zarr-indexing/mkdocs.yml
@@ -26,6 +26,9 @@ nav:
- ' zarr_indexing.messages': api/messages.md
- ' zarr_indexing.errors': api/errors.md
- Changelog: https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-indexing/CHANGELOG.md
+ # This site is a Read the Docs subproject of zarr-python; give readers a way
+ # back to the parent docs, which list every companion package.
+ - 'zarr-python ↪': https://zarr.readthedocs.io/
watch:
- src
diff --git a/packages/zarr-metadata/mkdocs.yml b/packages/zarr-metadata/mkdocs.yml
index 6c4a590b3c..18e1fc8c35 100644
--- a/packages/zarr-metadata/mkdocs.yml
+++ b/packages/zarr-metadata/mkdocs.yml
@@ -25,6 +25,9 @@ nav:
- ' zarr_metadata.v3.codec': api/v3/codec.md
- ' zarr_metadata.v3.data_type': api/v3/data_type.md
- Changelog: https://github.com/zarr-developers/zarr-python/blob/main/packages/zarr-metadata/CHANGELOG.md
+ # This site is a Read the Docs subproject of zarr-python; give readers a way
+ # back to the parent docs, which list every companion package.
+ - 'zarr-python ↪': https://zarr.readthedocs.io/
watch:
- src