Skip to content

Add API-doc site, format gate, recipe.yaml, bench - #3

Merged
conorbronsdon merged 2 commits into
mainfrom
ehsan-quick-wins
Jul 8, 2026
Merged

Add API-doc site, format gate, recipe.yaml, bench#3
conorbronsdon merged 2 commits into
mainfrom
ehsan-quick-wins

Conversation

@conorbronsdon

Copy link
Copy Markdown
Owner

Rolls the quick wins already proven on mojo-xml and mojo-feed onto this repo:

  • Canonical formatting: mojo format output committed as its own commit; new pixi run fmt task.
  • Format gate in CI: test workflow now fails if sources aren't mojo-format clean.
  • API-doc site: docs/render_api.py (copied from mojo-xml) + pixi run docs renders mojo doc JSON to a single-page HTML API reference; docs.yaml workflow builds and deploys it to GitHub Pages on pushes to main. Generated docs/api.json / docs/api.html are gitignored.
  • recipe.yaml: rattler-build recipe distributing the pure-Mojo source tree (not a compiled .mojopkg), same shape as mojo-xml's. Not wired to CI.
  • bench/: bench/bench_parse.mojo times render_html over the CommonMark spec corpus (652 documents); pixi run bench builds and runs it. Local task only, not in CI.
  • Docstring lint: package docstring summary now starts with a capital letter, so mojo doc emits no warnings.

Local verification: pixi run test 49/49 pass; pixi run docs writes docs/api.html; bench runs (~1.2 ms/corpus pass); pixi run fmt && git diff --exit-code clean.

🤖 Generated with Claude Code

@conorbronsdon
conorbronsdon merged commit 9c1932b into main Jul 8, 2026
1 check passed
@conorbronsdon
conorbronsdon deleted the ehsan-quick-wins branch July 8, 2026 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant