Skip to content

feat: add llms.txt to chisel-docs#65

Merged
asanvaq merged 5 commits into
canonical:mainfrom
asanvaq:ROCKS-3156-sphinx-llm
May 29, 2026
Merged

feat: add llms.txt to chisel-docs#65
asanvaq merged 5 commits into
canonical:mainfrom
asanvaq:ROCKS-3156-sphinx-llm

Conversation

@asanvaq
Copy link
Copy Markdown
Contributor

@asanvaq asanvaq commented May 22, 2026

This PR sets up sphinx-llm in the Chisel documentation build process to automatically generate both llms.txt and llms-full.txt files.

The changes are the following:

  • Added the sphinx_llm.txt to the extensions in conf.py
  • Included the required sphinx-llm config in conf.py
  • Added sphinx-llm to requirements.txt‎
  • Disabled the generation of the llms.txt content on a per-build basis as there’s no need to have Sphinx spend cycles (re)generating all the files while, for example, using sphinx-autobuild to check small edits in the docs. This was added to the Makefile build targets.
  • Added extra spaces in the variable list so the new variable is aligned with the rest.

@asanvaq asanvaq marked this pull request as ready for review May 22, 2026 14:22
@asanvaq asanvaq requested a review from cjdcordeiro May 22, 2026 14:22
Copy link
Copy Markdown
Collaborator

@cjdcordeiro cjdcordeiro left a comment

Choose a reason for hiding this comment

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

looks pretty good to me. thanks. just a couple of questions and nits

Comment thread docs/conf.py Outdated
Comment thread docs/conf.py Outdated
Comment thread docs/conf.py
@lczyk
Copy link
Copy Markdown

lczyk commented May 25, 2026

would love to see a pastebin of llms.txt generated from main. overall +1 for the feature though -- we'd be indirectly improving users experiance in all present and future llms. since its nvidia-driven standard i have no doubts it will at the very least become one of the standards if not the standard for crawler instructions for docs

asanvaq and others added 3 commits May 25, 2026 17:25
Co-authored-by: Cristovao Cordeiro <cristovao.cordeiro@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
@asanvaq asanvaq merged commit 552c43b into canonical:main May 29, 2026
5 checks passed
@asanvaq asanvaq deleted the ROCKS-3156-sphinx-llm branch May 29, 2026 14:59
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.

3 participants