Fix docs cross-refs and fail the docs build on warnings - #379
Merged
Merged
Conversation
The `connectrpc_grpcreflect` docstrings linked to `connectrpc.grpcreflect.*`, and `ErrorDetail.__init__` linked to a bare `[value()][]`; neither resolved, so `zensical` emitted nine warnings. CI missed them for two reasons: 1. `zensical build` exits 0 on warnings. `docs-build` now passes `--strict`; `docs-serve` stays lenient. 2. The docs workflow only ran on changes under `docs/` and `src/`, so edits to `connectrpc-grpcreflect` and `connectrpc-otel` never triggered it, even though `api.md` renders both. Signed-off-by: Stefan VanBuren <stefan@vanburen.xyz>
stefanvanburen
commented
Sep 30, 2026
| [tasks.docs-build] | ||
| help = "Build documentation" | ||
| cmd = "uv run --group docs zensical build" | ||
| cmd = "uv run --group docs zensical build --strict" |
Member
Author
There was a problem hiding this comment.
I think this was non-functional for awhile, but seems to be working now.
stefanvanburen
marked this pull request as ready for review
September 30, 2026 12:58
anuraaga
approved these changes
Oct 1, 2026
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
2 participants
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.
poe docs-serveprinted nine unresolved-autoref warnings, eight fromconnectrpc_grpcreflectdocstrings pointing at aconnectrpc.grpcreflectmodule that doesn't exist, and one from a bare[value()][]inErrorDetail.CI stayed green because
zensical buildexits 0 on warnings, and because the docs workflow never ran for changes underconnectrpc-grpcreflect/anyway.docs-buildnow uses--strict, and the workflow's path filters include both extension packages thatapi.mdrenders. With the docstring fixes reverted,uv run poe docs-buildnow aborts withRuntimeError: Aborted because --strict flag is set.