Skip to content

docs: add source-linked API reference - #7

Merged
bdbarnett merged 1 commit into
PyDevices:mainfrom
mossony:codex/sourcey-api-reference
Jul 20, 2026
Merged

docs: add source-linked API reference#7
bdbarnett merged 1 commit into
PyDevices:mainfrom
mossony:codex/sourcey-api-reference

Conversation

@mossony

@mossony mossony commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a deterministic reference generator for the CPython binding tables and public C headers
  • publish a Sourcey-powered API reference under the existing Pages site at /graphics/api/ while preserving the current homepage
  • organize 136 Python entries and 59 native C functions into seven searchable, source-linked reference sections
  • build and verify the documentation on pull requests, but deploy only from main

The current homepage gives a useful introduction and short API excerpt. This adds complete, navigable coverage of the public surface without changing the C extension or runtime behavior.

Validation

  • npm ci --prefix docs
  • npm run check --prefix docs
    • verified 136 Python entries
    • verified 59 native C functions
    • verified source links across 7 source files
  • git diff --check
  • browser QA of the generated landing page and framebuffer reference, with no console errors

@bdbarnett
bdbarnett merged commit aa6041e into PyDevices:main Jul 20, 2026
cursor Bot pushed a commit that referenced this pull request Jul 20, 2026
The #7 Deploy Pages run failed because `git describe --tags` needs tags
that the default shallow Actions checkout does not fetch, so `/api/`
never published. Fetch full history/tags in CI and fall back when no
release tag can be resolved.

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Brad Barnett <bdbarnett@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants