docs(zarr-metadata): docs-site polish: repo link, titles, RTD build skips, branding - #264
Closed
d-v-b wants to merge 4 commits into
Closed
docs(zarr-metadata): docs-site polish: repo link, titles, RTD build skips, branding#264d-v-b wants to merge 4 commits into
d-v-b wants to merge 4 commits into
Conversation
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
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
…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
d-v-b
changed the title
7 tasks
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 AI text below 🤖
Follow-ups to zarr-developers#4208, polishing the newly-live https://zarr-metadata.readthedocs.io/ site.
Repo link points at the package directory
The material header source widget linked to the zarr-python repository root, presenting the site as zarr-python's. It now links
packages/zarr-metadatalabeledzarr-python/packages/zarr-metadata, andedit_uriis absolute — with a subpath inrepo_url, mkdocs would otherwise concatenate the two into a broken edit link. (Star/fork counts still show zarr-python's numbers; Material parsesowner/repofrom the URL, so that's inherent to the monorepo.)Homepage browser title
The homepage
<title>rendered as "zarr-metadata - zarr-metadata" because Material appends the site name to explicit frontmatter titles. Dropping the frontmatter title makes it fall back to the site name alone.Skip unrelated RTD pull request builds
Both RTD projects rebuilt on every PR regardless of what changed. Each
.readthedocs.yamlnow has apost_checkoutrule that exits183(cancel build, report success) when the PR diff againstorigin/maindoes not touch its half of the repo: the zarr-metadata project skips PRs that leavepackages/zarr-metadatauntouched, and the zarr-python project skips PRs confined to it. Scoped toexternalversions becauseorigin/mainis only a meaningful diff base for PR builds; push builds tolateststill always run.Site branding
The package site gets the zarr logo and favicon (copied from the zarr-python docs
_static) instead of stock Material icons.All changes verified with strict local builds; pre-commit passes on every changed file.
🤖 Generated with Claude Code