Skip to content
Merged
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
13 changes: 13 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ build:
tools:
python: "3.12"
jobs:
post_checkout:
# Cancel pull request builds whose changes are confined to the
# zarr-metadata package, which has its own Read the Docs project. Exit
# code 183 cancels the build and reports success to the Git provider.
# Scoped to PR builds ("external" versions) because origin/main is only
# a meaningful diff base there. Read the Docs strips shell quoting from
# commands, so the exclude pathspec must use the quote-free :! form,
# not ':(exclude)'.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- :!packages/zarr-metadata;
then
exit 183;
fi
install:
- pip install --upgrade pip
- pip install .[remote] --group docs
Expand Down
10 changes: 10 additions & 0 deletions packages/zarr-metadata/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ build:
tools:
python: "3.12"
jobs:
post_checkout:
# Cancel pull request builds that do not touch this package. Exit code
# 183 cancels the build and reports success to the Git provider. Scoped
# to PR builds ("external" versions) because origin/main is only a
# meaningful diff base there.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- packages/zarr-metadata;
then
exit 183;
fi
install:
- pip install --upgrade pip
- pip install ./packages/zarr-metadata --group packages/zarr-metadata/pyproject.toml:docs
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/zarr-metadata/docs/_static/logo_bw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions packages/zarr-metadata/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
title: zarr-metadata
---

# zarr-metadata

Basic tools for modelling Zarr metadata, with minimal dependencies.
Expand Down
11 changes: 8 additions & 3 deletions packages/zarr-metadata/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
site_name: zarr-metadata
repo_name: zarr-developers/zarr-python
repo_url: https://github.com/zarr-developers/zarr-python
edit_uri: edit/main/packages/zarr-metadata/docs/
# The package lives in the zarr-python monorepo; point the header source
# widget at the package directory rather than the repository root.
repo_name: zarr-python/packages/zarr-metadata
repo_url: https://github.com/zarr-developers/zarr-python/tree/main/packages/zarr-metadata
# Absolute because mkdocs would otherwise append this to repo_url's subpath.
edit_uri: https://github.com/zarr-developers/zarr-python/edit/main/packages/zarr-metadata/docs/
site_description: Spec-defined metadata types, models, and validators for Zarr v2 and v3.
site_author: Davis Bennett
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://zarr-metadata.readthedocs.io/']
Expand Down Expand Up @@ -29,6 +32,8 @@ watch:
theme:
language: en
name: material
logo: _static/logo_bw.png
favicon: _static/favicon-96x96.png

palette:
# Light mode
Expand Down
Loading