docs(subpackages): render subpackage changelogs as docs pages - #4311
Merged
Conversation
The sidebar and landing page linked to CHANGELOG.md on the GitHub main branch, so the docs for any version showed the changelog of main. Add docs/release-notes.md, which includes CHANGELOG.md via pymdownx.snippets with the package root appended to base_path. The root file stays where towncrier, PyPI, and GitHub expect it, and each docs build now renders the release notes for its own version. The page is named release-notes.md rather than changelog.md because on a case-insensitive filesystem the latter shadows CHANGELOG.md and the include resolves to the page itself. Assisted-by: ClaudeCode:claude-fable-5-1 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Assisted-by: ClaudeCode:claude-fable-5-1 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
github-actions
Bot
added
the
needs release notes
Documentation build overview
|
Assisted-by: ClaudeCode:claude-fable-5-1 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…page Same change as for zarr-indexing: the sidebar and landing page linked to CHANGELOG.md on the GitHub main branch, so the docs for any version showed the changelog of main. Add docs/release-notes.md, which includes CHANGELOG.md via pymdownx.snippets with the package root in base_path. Neither package had the snippets extension enabled, so it is added with check_paths so an unresolved include fails the build. Assisted-by: ClaudeCode:claude-fable-5-1 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
d-v-b
changed the title
Documentation build overview
|
d-v-b
marked this pull request as ready for review
September 3, 2026 17:54
d-v-b
changed the title
Contributor
Author
|
the PR description is out of date. It poses changing subpackages outside of zarr-indexing as a follow-up. but I'm also doing that here. |
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.
This is a Claude-authored PR that updates how our subpackages render their release notes in the docs. It's a self-merge situation.
🤖 AI text below 🤖
The zarr-indexing docs sidebar and landing page linked to
CHANGELOG.mdon the GitHubmainbranch, so the docs for any version showed the changelog ofmain, and the link left the site entirely.This adds
docs/release-notes.md, which includesCHANGELOG.mdviapymdownx.snippetswith the package root appended tobase_path. The root file stays where towncrier, PyPI, and GitHub expect it, and each docs build now renders the release notes for its own version.tests/test_doc_examples.pymirrors the new base path so the include-graph test keeps validating it.The page is named
release-notes.mdrather thanchangelog.mdbecause on a case-insensitive filesystem (macOS)docs/changelog.mdshadowsCHANGELOG.mdand the include resolves to the page itself, rendering empty.Verified locally with
mkdocs build --strict,tests/test_doc_examples.py, and ruff.packages/zarr-metadatahas the same external changelog link and could get the same treatment in a follow-up.🤖 Generated with Claude Code