Skip to content

docs(zarr-metadata): docs-site polish: repo link, titles, RTD build skips, branding - #4210

Merged
d-v-b merged 4 commits into
zarr-developers:mainfrom
d-v-b:docs/zarr-metadata-repo-link
Jul 29, 2026
Merged

docs(zarr-metadata): docs-site polish: repo link, titles, RTD build skips, branding#4210
d-v-b merged 4 commits into
zarr-developers:mainfrom
d-v-b:docs/zarr-metadata-repo-link

Conversation

@d-v-b

@d-v-b d-v-b commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

minor style tweaks to the zarr-metadata docs page

written by claude, based on a PR here: d-v-b#264

Author attestation

  • I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct.

TODO

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

d-v-b added 3 commits July 29, 2026 20:59
@d-v-b
docs(zarr-metadata): point the site's repo link at the package directory
b43131c 
The material header source widget linked to the zarr-python repository
root, presenting the site as zarr-python's. Link the package directory
and label it zarr-python/packages/zarr-metadata instead. edit_uri
becomes absolute because mkdocs would append it to repo_url's subpath.

Assisted-by: ClaudeCode:claude-fable-5
@d-v-b
docs(zarr-metadata): drop redundant frontmatter title on the homepage
f2cfb55 
Material appends the site name to explicit frontmatter titles, so the
homepage browser title rendered as 'zarr-metadata - zarr-metadata'.
Without the frontmatter it falls back to the site name alone.

Assisted-by: ClaudeCode:claude-fable-5
@d-v-b
docs(zarr-metadata): skip unrelated RTD PR builds; add site logo and …
b7b25bc 
…favicon

Both Read the Docs projects rebuilt on every pull request regardless of
what changed. Each config now cancels PR builds via exit code 183 when
the diff against origin/main does not touch its half of the repo:
the zarr-metadata project skips PRs that leave packages/zarr-metadata
untouched, and the zarr-python project skips PRs confined to it. Scoped
to external versions because origin/main is only a meaningful diff base
for PR builds.

The package site also gets the zarr logo and favicon, copied from the
zarr-python docs, instead of stock Material icons.

Assisted-by: ClaudeCode:claude-fable-5
@github-actions github-actions Bot added the needs release notes Automatically applied to PRs which haven't added release notes label Jul 29, 2026
@d-v-b
fix(docs): quote-free exclude pathspec in RTD build-skip rule
29a9fb3 
Read the Docs strips shell quoting from build commands, so the quoted
':(exclude)packages/zarr-metadata' pathspec reached /bin/sh unquoted and
the bare parenthesis was a syntax error, failing every zarr PR build.
Use git's quote-free :! exclude form, which survives the stripping;
reproduced the mangling and verified both forms against dash locally.

Assisted-by: ClaudeCode:claude-fable-5
@d-v-b
d-v-b marked this pull request as ready for review July 29, 2026 19:31
@d-v-b

d-v-b commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

I'm going to self-merge this when it's green.

@d-v-b
d-v-b merged commit 69ca264 into zarr-developers:main Jul 29, 2026
38 checks passed
@d-v-b d-v-b mentioned this pull request Jul 29, 2026
Closed
d-v-b added a commit that referenced this pull request Jul 29, 2026
@d-v-b
chore(zarr-metadata): build 0.4.0 changelog (#4211)
63fc294 
Consume the pending news fragments (the #4119 model layer's feature and
removal notes, plus a new doc fragment for the standalone documentation
site and justfile from #4208/#4210) into CHANGELOG.md via towncrier for
the zarr_metadata-v0.4.0 release.

Assisted-by: ClaudeCode:claude-fable-5
d-v-b added a commit to d-v-b/zarr-python that referenced this pull request Jul 30, 2026
@d-v-b
docs(zarr-indexing): standalone documentation site; add package justfile
3fd36cd 
Mirror the treatment zarr-metadata received in zarr-developers#4208/zarr-developers#4210 onto
zarr-indexing: a self-contained mkdocs site under the package (own
mkdocs.yml, landing page, ndsel wire-format guide, mkdocstrings page per
module, and .readthedocs.yaml for a dedicated RTD project), so the
package presents as a separate project with docs versioned by its own
zarr_indexing-v* release tags rather than zarr-python's. The zarr-python
site's API Reference nav links out to it, and each RTD project now skips
PR builds that do not touch its half of the repo.

The package gains a pinned docs dependency group, a docs build job in its
CI workflow, and a justfile with package-scoped dev recipes. Two recipes
deviate from the zarr-metadata original by design:

- `test` runs against the workspace-root environment (`uv run --project
  ../.. --all-packages --group test`), because the chunk-resolution tests
  exercise this package against zarr's chunk grids and `zarr` is
  deliberately not a dependency of this package.
- `typecheck` uses plain `pyright`, unpinned and on the default
  interpreter, mirroring this package's own CI invocation. The
  zarr-metadata pin exists for a PEP 661 sentinel regression that
  zarr-indexing's sources do not hit.

composition.py gains the module docstring the other modules already have,
since mkdocstrings renders it as the page introduction.

Assisted-by: ClaudeCode:claude-fable-5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@d-v-b