feat(docs): add API reference generation and PR CI - #1
Merged
Merged
Conversation
Pin generation config from a discovery spike: single-file markdown renderer to docs/api/reference.md, filter expression dropping imported-name Indirections, github source_linker (normalized downstream). Static docspec parsing avoids TYPE_CHECKING import errors. Task: 1789724353
…reference scripts/generate-docs.py wraps pydoc-markdown (console script), wipes+regenerates docs/api/reference.md, and normalizes source links to blob/main/<path> (no SHA, no line anchor). Two runs on the same commit are byte-identical. Task: 1789724353
Task: 1789724353
Surfaced by the new make lint / CI gate; mechanical line-wrapping and trailing commas only, no logic change. Task: 1789724353
Task: 1789724353
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.
Summary
Testing
uv run make lintuv run make typecheckuv run make testuv run make docs-check