Commit 69ca264
authored
docs(zarr-metadata): docs-site polish: repo link, titles, RTD build skips, branding (#4210)
* docs(zarr-metadata): point the site's repo link at the package directory
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
* docs(zarr-metadata): drop redundant frontmatter title on the homepage
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
* docs(zarr-metadata): skip unrelated RTD PR builds; add site logo and 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
* fix(docs): quote-free exclude pathspec in RTD build-skip rule
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-51 parent b2ece6f commit 69ca264
6 files changed
Lines changed: 31 additions & 7 deletions
File tree
- packages/zarr-metadata
- docs
- _static
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
8 | 21 | | |
9 | 22 | | |
10 | 23 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
12 | 22 | | |
13 | 23 | | |
14 | 24 | | |
| |||
Loading
Loading
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
4 | | - | |
5 | 1 | | |
6 | 2 | | |
7 | 3 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | | - | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
5 | 8 | | |
6 | 9 | | |
7 | 10 | | |
| |||
29 | 32 | | |
30 | 33 | | |
31 | 34 | | |
| 35 | + | |
| 36 | + | |
32 | 37 | | |
33 | 38 | | |
34 | 39 | | |
| |||
0 commit comments