Skip to content

Add markdown button and make llms.txt available #101

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

Open
neon60 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add markdown button and make llms.txt available #101

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 @@ -44,6 +44,7 @@
html_theme_options = {
"flavor": "amdgpu",
"link_main_doc": True,
"use_download_button": True,
# Add any additional theme options here
}
extensions = [
Expand All @@ -57,6 +58,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

# Add the following replacements to every RST file.
rst_prolog = f"""
.. |rocm_version| replace:: {rocm_version}
Expand Down
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,4 +1,4 @@
rocm-docs-core==1.35.0
rocm-docs-core[llms]==1.38.0
sphinx-reredirects
sphinxcontrib.datatemplates==0.11.0
Sphinx-Substitution-Extensions==2026.1.12
10 changes: 8 additions & 2 deletions docs/sphinx/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ docutils==0.21.2
# myst-parser
# pydata-sphinx-theme
# sphinx
# sphinx-markdown-builder
# sphinx-substitution-extensions
exceptiongroup==1.3.0
# via ipython
Expand Down Expand Up @@ -193,7 +194,7 @@ requests==2.32.5
# via
# pygithub
# sphinx
rocm-docs-core==1.35.0
rocm-docs-core[llms]==1.38.0
# via -r requirements.in
rpds-py==0.28.0
# via
Expand All @@ -218,6 +219,7 @@ sphinx==8.1.3
# sphinx-copybutton
# sphinx-design
# sphinx-external-toc
# sphinx-markdown-builder
# sphinx-notfound-page
# sphinx-reredirects
# sphinx-substitution-extensions
Expand All @@ -231,6 +233,8 @@ 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.1.0
# via rocm-docs-core
sphinx-reredirects==0.1.6
Expand Down Expand Up @@ -258,7 +262,9 @@ sqlalchemy==2.0.44
stack-data==0.6.3
# via ipython
tabulate==0.9.0
# via jupyter-cache
# via
# jupyter-cache
# sphinx-markdown-builder
tomli==2.3.0
# via sphinx
tornado==6.5.2
Expand Down
Loading