docs: add pre-built single-page HTML documentation#120
Closed
seriouscoderone wants to merge 3 commits intoWebOfTrust:mainfrom
Closed
docs: add pre-built single-page HTML documentation#120seriouscoderone wants to merge 3 commits intoWebOfTrust:mainfrom
seriouscoderone wants to merge 3 commits intoWebOfTrust:mainfrom
Conversation
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>
Collaborator
|
please remove the generated HTML file from the PR. we are supposed to be using readthedocs for this, which should meet the needs of AI agents. |
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
2 participants
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
singlehtmloutput atdocs/singlehtml/index.htmlDetails
The
docs/singlehtml/directory contains the complete rendered API documentation built withsphinx-build -b singlehtml. This includes all autodoc-generated content for:signify.app(aiding, clienting, coring, credentialing, ending, escrowing)signify.core(authing, keeping)Test plan
docs/singlehtml/index.htmlin a browser and verify all API content renders🤖 Generated with Claude Code