diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1edd099ebd..55b5d6fed0 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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 diff --git a/packages/zarr-metadata/.readthedocs.yaml b/packages/zarr-metadata/.readthedocs.yaml index b89846f570..ace6ccddfd 100644 --- a/packages/zarr-metadata/.readthedocs.yaml +++ b/packages/zarr-metadata/.readthedocs.yaml @@ -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 diff --git a/packages/zarr-metadata/docs/_static/favicon-96x96.png b/packages/zarr-metadata/docs/_static/favicon-96x96.png new file mode 100644 index 0000000000..e77977ccf4 Binary files /dev/null and b/packages/zarr-metadata/docs/_static/favicon-96x96.png differ diff --git a/packages/zarr-metadata/docs/_static/logo_bw.png b/packages/zarr-metadata/docs/_static/logo_bw.png new file mode 100644 index 0000000000..df1979d3cc Binary files /dev/null and b/packages/zarr-metadata/docs/_static/logo_bw.png differ diff --git a/packages/zarr-metadata/docs/index.md b/packages/zarr-metadata/docs/index.md index 2004f2dc54..58e4f290c6 100644 --- a/packages/zarr-metadata/docs/index.md +++ b/packages/zarr-metadata/docs/index.md @@ -1,7 +1,3 @@ ---- -title: zarr-metadata ---- - # zarr-metadata Basic tools for modelling Zarr metadata, with minimal dependencies. diff --git a/packages/zarr-metadata/mkdocs.yml b/packages/zarr-metadata/mkdocs.yml index 40912d6251..6c4a590b3c 100644 --- a/packages/zarr-metadata/mkdocs.yml +++ b/packages/zarr-metadata/mkdocs.yml @@ -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/'] @@ -29,6 +32,8 @@ watch: theme: language: en name: material + logo: _static/logo_bw.png + favicon: _static/favicon-96x96.png palette: # Light mode