Skip to content

feat(docs): add llms.txt and Markdown page versions - #1719

Merged
ariostas merged 2 commits into
mainfrom
feat/llms-txt
Sep 30, 2026
Merged

ariostas merged 2 commits into
mainfrom
feat/llms-txt

Conversation

@henryiii

Copy link
Copy Markdown
Member

🤖 AI text below 🤖

Port of scikit-hep/uhi#252. Adds LLM-friendly docs output with NVIDIA's sphinx-llm (sphinx_llm.txt extension). It runs the markdown builder alongside the HTML build and merges the results, so the whole thing is one extension and one build:

  • llms.txt — sitemap with a one-line description per page.
  • llms-full.txt — all docs in one file (5 MB here, given the API pages).
  • <page>.html.md next to each <page>.html.

llms_txt_description is set because the default summary is the full README. index.rst gets a meta description, which llms.txt uses for the index page.

@github-actions github-actions Bot added the type/feat PR title type: feat (set automatically) label Sep 12, 2026

@ariostas ariostas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thank you, @henryiii! (Please merge if you're not planing to make any more changes)

@codecov

codecov Bot commented Sep 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.40%. Comparing base (1c06db0) to head (884f1c2).
⚠️ Report is 54 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

see 47 files with indirect coverage changes

@ariostas
ariostas merged commit 883aba3 into main Sep 30, 2026
46 of 47 checks passed
@ariostas
ariostas deleted the feat/llms-txt branch September 30, 2026 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/feat PR title type: feat (set automatically)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants