Skip to content

Add banner display to live docs #83

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
yugang-amd merged 1 commit into from
Feb 11, 2026
Merged

Add banner display to live docs #83

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
4 changes: 3 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
release = version
html_title = f"AMD GPU Driver (amdgpu) {version}"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved."
copyright = "Copyright (c) 2026 Advanced Micro Devices, Inc. All rights reserved."

# Supported linux version numbers
ubuntu_version_numbers = [('24.04', 'noble'), ('22.04', 'jammy')]
Expand Down Expand Up @@ -43,6 +43,7 @@
html_theme = "rocm_docs_theme"
html_theme_options = {
"flavor": "amdgpu",
"announcement": f"AMD GPU Driver 31.10.0 is a technology preview intended for use only with <a id='rocm-banner' href='https://rocm.docs.amd.com/en/7.11.0-preview/index.html'>AMD ROCm 7.11.0 technology preview</a>. For production use, continue to use AMD GPU Driver {version} documentation.",
"link_main_doc": True,
# Add any additional theme options here
}
Expand All @@ -59,6 +60,7 @@

# Add the following replacements to every RST file.
rst_prolog = f"""
.. |version| replace:: {version}
.. |rocm_version| replace:: {rocm_version}
.. |amdgpu_version| replace:: {amdgpu_version}
.. |amdgpu_url_version| replace:: {amdgpu_url_version}
Expand Down