Skip to content

docs: publish generated public API reference - #203

Merged
codeforester merged 3 commits into
mainfrom
documentation/194-20260809-generated-api-reference
Aug 9, 2026
Merged

docs: publish generated public API reference#203
codeforester merged 3 commits into
mainfrom
documentation/194-20260809-generated-api-reference

Conversation

@codeforester

@codeforester codeforester commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Closes #194

Summary

  • add a generated reference for every symbol in base_cli.all
  • add deterministic --check validation so public exports cannot drift from docs
  • link the reference from README, docs navigation, and the strict docs workflow

Validation

  • python scripts/validate_docs.py
  • python scripts/generate_api_reference.py --check
  • ./tests/validate.sh
  • python -m mkdocs build --strict
  • pytest -q tests/test_public_api.py tests/test_api_stability.py

@codeforester
codeforester force-pushed the documentation/194-20260809-generated-api-reference branch from b2a4402 to 527ede8 Compare August 9, 2026 17:07
@codeforester
codeforester merged commit 59a4ce9 into main Aug 9, 2026
62 of 92 checks passed
@codeforester
codeforester deleted the documentation/194-20260809-generated-api-reference branch August 9, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[v1.0] Generate and publish complete public API reference documentation

1 participant

@codeforester