Skip to content

docs: add sphinx-llms-txt extension#1303

Merged
niccokunzmann merged 1 commit intocollective:mainfrom
claw-explorer:add-sphinx-llms-txt
Mar 29, 2026
Merged

docs: add sphinx-llms-txt extension#1303
niccokunzmann merged 1 commit intocollective:mainfrom
claw-explorer:add-sphinx-llms-txt

Conversation

@claw-explorer
Copy link
Copy Markdown

@claw-explorer claw-explorer commented Mar 28, 2026

Summary

Add the sphinx-llms-txt extension to the documentation build. This generates a summary llms.txt file and a single combined documentation llms-full.txt file for AI/LLM consumption of the documentation.

Changes

  • Added sphinx-llms-txt>=0.7.1 to the docs dependency group in pyproject.toml
  • Added sphinx_llms_txt to the Sphinx extensions list in docs/conf.py

Verification

Built the documentation locally and confirmed that both llms.txt and llms-full.txt are generated successfully:

sphinx-llms-txt: Created llms-full.txt with 109 sources and 6825 lines
sphinx-llms-txt: created llms.txt

The build completes with no new warnings.

Closes #1302


📚 Documentation preview 📚: https://icalendar--1303.org.readthedocs.build/

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community bot commented Mar 28, 2026

Documentation build overview

📚 icalendar | 🛠️ Build #32020110 | 📁 Comparing 9bc08a3 against latest (8d9046d)


🔍 Preview build

Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
File Status
404.html 📝 modified
reference/changelog.html 📝 modified

Add sphinx-llms-txt to the Sphinx extensions list and the docs
dependency group. This generates llms.txt and llms-full.txt files
for AI/LLM consumption of the documentation.

Closes collective#1302
Copy link
Copy Markdown
Member

@niccokunzmann niccokunzmann left a comment

Choose a reason for hiding this comment

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

@niccokunzmann niccokunzmann merged commit feea1af into collective:main Mar 29, 2026
32 checks passed
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.

Add sphinx-llms-txt to documentation configuration

2 participants