Skip to content

Generate llms files with rocm_docs_generate_llms #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spraveenio merged 1 commit into from
Aug 11, 2026
+27 −7
Merged

Generate llms files with rocm_docs_generate_llms #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
html_theme_options = {
"flavor": "instinct",
"link_main_doc": True,
"use_download_button": True,
"repository_url": "https://github.com/rocm/gpu-operator",
# Add any additional theme options here
"announcement": (
Expand All @@ -37,6 +38,11 @@

exclude_patterns = ['.venv']

# 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

rst_prolog = """
.. |version| replace:: v{version}
""".format(version=version)
2 changes: 1 addition & 1 deletion docs/sphinx/requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
rocm-docs-core==1.18.1
rocm-docs-core[llms]==1.38.0
sphinx-reredirects
Sphinx-Substitution-Extensions==2025.6.6
26 changes: 20 additions & 6 deletions docs/sphinx/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ babel==2.16.0
# via
# pydata-sphinx-theme
# sphinx
beartype==0.22.9
# via sphinx-substitution-extensions
beautifulsoup4==4.12.3
# via pydata-sphinx-theme
breathe==4.35.0
Expand Down Expand Up @@ -51,6 +53,8 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
# sphinx-markdown-builder
# sphinx-substitution-extensions
exceptiongroup==1.2.2
# via ipython
executing==2.2.0
Expand Down Expand Up @@ -118,7 +122,9 @@ mdurl==0.1.2
myst-nb==1.1.2
# via rocm-docs-core
myst-parser==4.0.0
# via myst-nb
# via
# myst-nb
# sphinx-substitution-extensions
nbclient==0.10.2
# via
# jupyter-cache
Expand All @@ -133,6 +139,7 @@ nest-asyncio==1.6.0
packaging==24.2
# via
# ipykernel
# pydata-sphinx-theme
# sphinx
parso==0.8.4
# via jedi
Expand All @@ -150,7 +157,7 @@ pure-eval==0.2.3
# via stack-data
pycparser==2.22
# via cffi
pydata-sphinx-theme==0.16.0
pydata-sphinx-theme==0.15.4
# via
# rocm-docs-core
# sphinx-book-theme
Expand Down Expand Up @@ -187,7 +194,7 @@ requests==2.32.3
# via
# pygithub
# sphinx
rocm-docs-core==1.18.1
rocm-docs-core[llms]==1.38.0
# via -r requirements.in
rpds-py==0.22.3
# via
Expand All @@ -212,20 +219,26 @@ sphinx==8.1.3
# sphinx-copybutton
# sphinx-design
# sphinx-external-toc
# sphinx-markdown-builder
# sphinx-notfound-page
# sphinx-reredirects
sphinx-book-theme==1.1.3
# sphinx-substitution-extensions
sphinx-book-theme==1.1.4
# via rocm-docs-core
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.6.1
# via rocm-docs-core
sphinx-external-toc==1.0.1
# via rocm-docs-core
sphinx-markdown-builder==0.6.10
# via rocm-docs-core
sphinx-notfound-page==1.0.4
# via rocm-docs-core
sphinx-reredirects==0.1.6
# via -r requirements.in
sphinx-substitution-extensions==2025.6.6
# via -r requirements.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
Expand All @@ -243,7 +256,9 @@ sqlalchemy==2.0.37
stack-data==0.6.3
# via ipython
tabulate==0.9.0
# via jupyter-cache
# via
# jupyter-cache
# sphinx-markdown-builder
tomli==2.1.0
# via sphinx
tornado==6.4.2
Expand Down Expand Up @@ -278,4 +293,3 @@ wrapt==1.17.0
# via deprecated
zipp==3.21.0
# via importlib-metadata
Sphinx-Substitution-Extensions==2025.6.6
Loading