Skip to content

Comments

docs: add pre-built single-page HTML documentation#120

Open
seriouscoderone wants to merge 3 commits intoWebOfTrust:mainfrom
seriouscoderone:main
Open

docs: add pre-built single-page HTML documentation#120
seriouscoderone wants to merge 3 commits intoWebOfTrust:mainfrom
seriouscoderone:main

Conversation

@seriouscoderone
Copy link

Summary

  • Adds pre-built Sphinx singlehtml output at docs/singlehtml/index.html
  • All API documentation (signify.app and signify.core modules) in a single HTML file
  • Enables AI assistants and tools to easily reference the latest API docs directly from the repo without building locally or fetching from readthedocs

Details

The docs/singlehtml/ directory contains the complete rendered API documentation built with sphinx-build -b singlehtml. This includes all autodoc-generated content for:

  • signify.app (aiding, clienting, coring, credentialing, ending, escrowing)
  • signify.core (authing, keeping)

Test plan

  • Open docs/singlehtml/index.html in a browser and verify all API content renders
  • Verify cross-reference links work within the single page

🤖 Generated with Claude Code

seriouscoderone and others added 3 commits February 14, 2026 09:07
Publish the Sphinx singlehtml output so the latest API documentation
can be easily referenced by AI assistants and tools without needing
to build locally or fetch from readthedocs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove theme fonts, CSS, and JS from tracking. Only the index.html
content matters for AI assistant reference; the static assets are
unnecessary bloat.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Runs sphinx-build on every push to main, strips _static assets,
and auto-commits the updated index.html if it changed.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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