Skip to content

docs(hipsparse): enable generating llms.txt - #12036

Merged
peterjunpark merged 3 commits into
developfrom
users/peterjunpark/hipsparse/llmstxt
Sep 22, 2026
Merged

peterjunpark merged 3 commits into
developfrom
users/peterjunpark/hipsparse/llmstxt

Conversation

@peterjunpark

@peterjunpark peterjunpark commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

Motivation

  • Enable generating llms.txt and llms-full.txt (see https://llmstxt.org) for LLM-assisted access.

  • Enable a download button to download the source markup.

Technical Details

  • Add rocm_docs_generate_llms = True in the Sphinx config

Issue Tracking

ISSUE ID: AIROCDOC-4235

Test Plan

Look at

Test Result

Looks ok. Passes Chrome's Lighthouse audit for agentic browsing:

image

Submission Checklist

@peterjunpark
peterjunpark requested review from a team as code owners September 14, 2026 12:49
@peterjunpark

Copy link
Copy Markdown
Contributor Author

/docs-preview

@peterjunpark peterjunpark changed the title docs(hipsolver): enable generating llms.txt docs(hipsparse): enable generating llms.txt Sep 14, 2026
@assistant-librarian

Copy link
Copy Markdown
Contributor

Docs preview for hipsparse is building on Read the Docs: https://rocm.docs.amd.com/projects/hipSPARSE/en/users-peterjunpark-hipsparse-llmstxt/ (Note: If a pull request includes multiple projects, only the preview for the first project will be built.)

@therock-pr-bot

therock-pr-bot Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ⚠️ Warning Error: Source/code files changed without an accompanying unit test.
Expected: add at least one test file named like test_<name>.py / test_<name>.cpp (or <name>_test.*).
Current: code file(s) changed: projects/hipsparse/docs/conf.py; no test file found
🔎 pre-commit ✅ Pass —
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —
🤖 therock-pr-bot ✅ Pass —

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

@therock-pr-bot

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@dso-amd dso-amd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@peterjunpark
peterjunpark merged commit dc7b2a3 into develop Sep 22, 2026
33 of 34 checks passed
@peterjunpark
peterjunpark deleted the users/peterjunpark/hipsparse/llmstxt branch September 22, 2026 16:57
@assistant-librarian

Copy link
Copy Markdown
Contributor

TheRock Submodule Bump Activity

Newest first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants