Add llms.txt docs#2925
Merged
Merged
Conversation
- Add sphinx-llms-txt extension and config - Remove .txt from source_suffix - Tighten exclude_patterns (venv, node_modules, _templates, includes/*) - Add html_baseurl fallback for local builds Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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
Adds
sphinx-llms-txtto the Sphinx documentation build so thatllms.txtandllms-full.txtare generated automatically alongside the existing HTML output.llms.txtis a standard for making documentation consumable by LLMs —llms.txtis a structured index of doc pages with links, andllms-full.txtis the full documentation concatenated into a single plain-text file.Once merged, the files will be served at:
Changes
doc/requirements.txt/generated-doc/out/requirements.txt— addsphinx-llms-txtdoc/conf.py/generated-doc/out/conf.py:sphinx_llms_txtextension with title, summary, andllms-full.txtenabled.txtfromsource_suffix(was causingrequirements.txtto appear as a doc page)exclude_patternsto prevent venv, node_modules,_templates,includes/*partials, andrequirements.txtfrom being treated as source documentshtml_baseurlso local builds also produce absolute linksNo changes to
.readthedocs.yaml- ReadTheDocs already installs fromgenerated-doc/out/requirements.txtand runs Sphinx ongenerated-doc/out/conf.py, so the new files will be generated on every ReadTheDocs build automatically.