Generate llms files with rocm_docs_generate_llms - #105
Open
neon60 wants to merge 1 commit into
Open
Conversation
Enable llms.txt and llms-full.txt generation from the resolved doctree via rocm_docs_generate_llms, and add the per-page Markdown download button. Pin rocm-docs-core to 1.38.0 with the llms extra. Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
1 task
neon60
commented
Aug 11, 2026
| @@ -1,3 +1,3 @@ | |||
| rocm-docs-core | |||
| rocm-docs-core[llms]==1.38.0 | |||
Author
There was a problem hiding this comment.
The latest (1.39.0) rocm docs core has some problems. I will try to ask for a fixed release.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enables generation of llms.txt / llms-full.txt for the Network Operator documentation site using rocm-docs-core’s built-in llms support, and updates the docs build dependencies accordingly.
Changes:
- Pin
rocm-docs-coreto1.38.0and enable the[llms]extra to pull insphinx-markdown-builder. - Enable
rocm_docs_generate_llms = Trueso Sphinx builds emitllms.txtandllms-full.txt. - Enable
use_download_buttonin the docs theme options.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/sphinx/requirements.txt | Locks dependency set including rocm-docs-core[llms]==1.38.0 and the new sphinx-markdown-builder dependency. |
| docs/sphinx/requirements.in | Pins rocm-docs-core to 1.38.0 and enables the [llms] extra. |
| docs/conf.py | Turns on llms file generation and enables the per-page download button. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+35
to
+39
| # Generate llms.txt and llms-full.txt after each build (the llms.txt standard, | ||
| # https://llmstxt.org/). See the rocm-docs-core guide: | ||
| # https://rocm.docs.amd.com/projects/rocm-docs-core/en/latest/user_guide/llms.html | ||
| rocm_docs_generate_llms = True | ||
|
|
Collaborator
|
@neon60 Please check the copilot review comments, thanks! |
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.
Motivation
Enable llms.txt / llms-full.txt generation for the Network Operator docs, so the site publishes machine-readable documentation following the llms.txt standard (https://llmstxt.org/). This aligns the project with the shared approach used across the Instinct documentation set (k8s-device-plugin, container-toolkit, gpu-operator, gpu-cluster-networking, amdgpu-docs, instinct-docs), using the built-in support in rocm-docs-core.
Technical Details
The rocm-docs-core dependency is now pinned rather than floating: the [llms] extra requires a version that ships the generator, and an unpinned spec would resolve to the latest 1.39.0, whose published wheel has a malformed projects.yaml that breaks the build (already fixed upstream on develop, pending a patch release). Pinning to 1.38.0 avoids that.
Test Plan
Test Result
Build succeeds (build succeeded, 23 warnings) and logs Wrote llms.txt and llms-full.txt. Generated llms.txt (2 KB) has the correct # Network Operator header and indexes all pages; llms-full.txt (157 KB) has correct per-page sections with prose filtering. The 23 warnings are pre-existing, unrelated to this change.
Submission Checklist