docs(amdsmi): generate llms files and enable download button#8542
Closed
neon60 wants to merge 1 commit into
Closed
docs(amdsmi): generate llms files and enable download button#8542neon60 wants to merge 1 commit into
neon60 wants to merge 1 commit into
Conversation
Bump rocm-docs-core to 1.36.0 with the llms extra and rename the enablement flag to rocm_docs_generate_llms (renamed upstream in 1.36.0). Generate both llms.txt and llms-full.txt from the resolved doctree, replacing the manually curated static llms.txt and its html_extra_path entry, and enable the per-page Markdown download button. Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
github-actions
Bot
added
documentation
❌ PR Check — Action Required
📖 Need help? See the Policy FAQ for details on every check and how to fix failures. |
|
🚫 Please fix the failed policies before requesting reviews. The following policy checks failed:
The |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the AMD SMI documentation build configuration to use the latest rocm-docs-core LLM index generation and to enable per-page Markdown downloads via the ROCm docs theme.
Changes:
- Bump
rocm-docs-coreto1.36.0and enable thellmsextra in the Sphinx doc requirements. - Switch from a committed, curated
docs/llms.txtto generatedllms.txt/llms-full.txtvia the newrocm_docs_generate_llmsflag. - Enable the theme’s per-page download button (
use_download_button).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| projects/amdsmi/docs/sphinx/requirements.txt | Updates the compiled Sphinx dependency lockfile for rocm-docs-core[... ,llms]==1.36.0 and related transitive deps. |
| projects/amdsmi/docs/sphinx/requirements.in | Enables the llms extra for rocm-docs-core at 1.36.0. |
| projects/amdsmi/docs/llms.txt | Removes the previously committed curated llms.txt index in favor of generated outputs. |
| projects/amdsmi/docs/conf.py | Enables rocm_docs_generate_llms and turns on the theme download button. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+55
to
+58
| # 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 | ||
| html_extra_path = ["llms.txt"] | ||
| rocm_docs_generate_llms_full = True | ||
| rocm_docs_generate_llms = True |
Contributor
Author
|
Duplication: #8549 |
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
AMD SMI already using the rocm docs core llms generation feature, we need to update to the latest one.
Technical Details
Bump rocm-docs-core to 1.36.0 with the llms extra and rename the enablement flag to rocm_docs_generate_llms (renamed upstream in 1.36.0). Generate both llms.txt and llms-full.txt from the resolved doctree, replacing the manually curated static llms.txt and its html_extra_path entry, and enable the per-page Markdown download button.
JIRA ID
AIROCDOC-4086
Test Plan
Test Result
Submission Checklist