Skip to content

Add markdown button and make llms.txt available - #101

Open
neon60 wants to merge 1 commit into
developfrom
llm_comp_sol
Open

Add markdown button and make llms.txt available#101
neon60 wants to merge 1 commit into
developfrom
llm_comp_sol

Conversation

@neon60

@neon60 neon60 commented May 21, 2026

Copy link
Copy Markdown
Contributor

Motivation

Enable llms.txt / llms-full.txt generation for the AMD GPU Driver (amdgpu) 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-cluster-networking, instinct-docs), using the built-in support in rocm-docs-core.

Technical Details

  • Enable generation via rocm_docs_generate_llms = True in docs/conf.py, which produces both llms.txt and llms-full.txt from the resolved doctree at build time.
  • Add use_download_button: True to html_theme_options for the per-page Markdown download button.
  • Bump rocm-docs-core from 1.35.0 to 1.38.0 and add the [llms] extra in docs/sphinx/requirements.in; regenerate requirements.txt (Python 3.10, matching .readthedocs.yaml), which pulls in sphinx-markdown-builder. Existing pins (sphinxcontrib.datatemplates, Sphinx-Substitution-Extensions, sphinx-reredirects) are preserved.

Uses rocm-docs-core 1.38.0 rather than the latest 1.39.0: the published 1.39.0 wheel ships a malformed projects.yaml that breaks the build (already fixed upstream on develop, pending a patch release).

Test Plan

  • Regenerated docs/sphinx/requirements.txt with pip-compile under Python 3.10; confirmed the [llms] extra and all existing dependencies resolve.
  • Ran a full sphinx-build -b html in a clean python:3.10-slim container with the pinned requirements, reproducing the Read the Docs environment.
  • Verified llms.txt and llms-full.txt are generated and inspected their content.

Test Result

Build succeeds (build succeeded, 47 warnings) and logs Wrote llms.txt and llms-full.txt. Generated llms.txt (3 KB) has the correct # AMD GPU Driver (amdgpu) header and indexes all pages; llms-full.txt (114 KB) has correct per-page sections with prose filtering. The 47 warnings are pre-existing, unrelated to this change.

Submission Checklist

@neon60
neon60 requested review from a team and saadrahim as code owners May 21, 2026 11:08
@neon60 neon60 changed the title Llm comp sol Add markdown button and make llms.txt available May 21, 2026
@neon60
neon60 requested review from adeljo-amd and j-stephan May 21, 2026 11:10
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. Bump rocm-docs-core to 1.38.0 with the llms extra.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>
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