From 8c5f9c038abdac3f04a1e6aa4c1a5f12477e6077 Mon Sep 17 00:00:00 2001
From: Sam Wu <22262939+samjwu@users.noreply.github.com>
Date: Mon, 9 Sep 2024 13:29:37 -0600
Subject: [PATCH 1/2] fix(theme.py): Fix phrasing of banner for old doc
versions
---
src/rocm_docs/theme.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py
index 79407e8b..5b650308 100644
--- a/src/rocm_docs/theme.py
+++ b/src/rocm_docs/theme.py
@@ -86,7 +86,7 @@ def _update_banner(
if version_type == util.VersionType.RELEASE_CANDIDATE:
announcement_info = "This page contains changes for a test release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
elif version_type == util.VersionType.OLD_RELEASE:
- announcement_info = "This is an old version of ROCm documentation. Read the latest ROCm release documentation to stay informed of all our developments."
+ announcement_info = "This is not the latest version of ROCm documentation. See ROCm documentation for the latest version."
elif version_type == util.VersionType.DEVELOPMENT:
announcement_info = "This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
From 04659891a67f0c0241074ced6851299c4dd5c850 Mon Sep 17 00:00:00 2001
From: Sam Wu <22262939+samjwu@users.noreply.github.com>
Date: Mon, 9 Sep 2024 13:41:36 -0600
Subject: [PATCH 2/2] feat(custom.css): Use light blue text for banner
hyperlinks
---
src/rocm_docs/rocm_docs_theme/static/custom.css | 4 ++++
src/rocm_docs/theme.py | 6 +++---
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/src/rocm_docs/rocm_docs_theme/static/custom.css b/src/rocm_docs/rocm_docs_theme/static/custom.css
index 5688d301..57ef4db1 100644
--- a/src/rocm_docs/rocm_docs_theme/static/custom.css
+++ b/src/rocm_docs/rocm_docs_theme/static/custom.css
@@ -314,3 +314,7 @@ a#ot-sdk-btn {
:not(p) img {
margin-bottom: 1rem;
}
+
+#rocm-banner {
+ color: #80dfff;
+}
diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py
index 5b650308..9c7e9520 100644
--- a/src/rocm_docs/theme.py
+++ b/src/rocm_docs/theme.py
@@ -84,11 +84,11 @@ def _update_banner(
announcement_info: str
if version_type == util.VersionType.RELEASE_CANDIDATE:
- announcement_info = "This page contains changes for a test release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
+ announcement_info = "This page contains changes for a test release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
elif version_type == util.VersionType.OLD_RELEASE:
- announcement_info = "This is not the latest version of ROCm documentation. See ROCm documentation for the latest version."
+ announcement_info = "This is not the latest version of ROCm documentation. See ROCm documentation for the latest version."
elif version_type == util.VersionType.DEVELOPMENT:
- announcement_info = "This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
+ announcement_info = "This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments."
theme_opts.setdefault("announcement", announcement_info)