Add the sphinx-llms-txt docs plugin for better LLM integration#1482
Open
Dev-iL wants to merge 2 commits intoapache:mainfrom
Open
Add the sphinx-llms-txt docs plugin for better LLM integration#1482Dev-iL wants to merge 2 commits intoapache:mainfrom
Dev-iL wants to merge 2 commits intoapache:mainfrom
Conversation
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
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.
Add the sphinx-llms-txt extension to Hamilton's Sphinx documentation build. This auto-generates
llms.txt(a compact index) andllms-full.txt(complete docs in one Markdown file) llms-txt on every documentation deploy.The plugin supports code file inclusion, custom summaries, and size limits. Readthedocs Since Hamilton already uses Sphinx + MyST on Read the Docs, integration requires only adding the extension to conf.py and configuring sections. This gives every LLM provider access to current, version-specific Hamilton documentation through a standardized URL.
Changes
sphinx-llms-txtto pyproject.toml anddocs/conf.pyHow I tested this
Built the docs locally.
Notes
Checklist