Skip to content

feat: Add ROCm-LS announcement #1436

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

Closed
SwRaw wants to merge 2 commits into from
Closed

feat: Add ROCm-LS announcement #1436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e19e569
feat: Add ROCm-LS announcement
SwRaw Oct 8, 2025
b21b40d
feat: add CUID project
SwRaw Apr 13, 2026
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
3 changes: 3 additions & 0 deletions src/rocm_docs/data/projects.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ projects:
target: https://rocm.docs.amd.com/projects/aqlprofile/en/${version}
development_branch: amd-staging
composable_kernel: https://rocm.docs.amd.com/projects/composable_kernel/en/${version}
cuid:
target: https://rocm.docs.amd.com/projects/cuid/en/${version}
development_branch: develop
gpuaidev:
target: https://rocm.docs.amd.com/projects/ai-developer-hub/en/${version}
development_branch: main
Expand Down
17 changes: 17 additions & 0 deletions src/rocm_docs/theme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,22 @@ def _update_banner(

theme_opts.setdefault("announcement", announcement_info)

def _update_banner_rocm_ls(
flavor: str, version_type: util.VersionType, theme_opts: dict[str, Any]
) -> None:
if flavor != "rocm-ls":
return

if version_type == util.VersionType.LATEST_RELEASE:
return

announcement_info: str
if version_type == util.VersionType.OLD_RELEASE:
announcement_info = "This is not the latest version of ROCm-LS documentation. See <a id='rocm-banner' href='https://rocm.docs.amd.com/projects/rocm-ls/en/latest/'>ROCm-LS documentation</a> for the latest version."
elif version_type == util.VersionType.DEVELOPMENT:
announcement_info = "This page contains proposed changes for a future release of ROCm-LS. Read the <a id='rocm-banner' href='https://rocm.docs.amd.com/projects/rocm-ls/en/latest/'>latest release of ROCm-LS documentation</a> for your production environments."

theme_opts.setdefault("announcement", announcement_info)

def _update_theme_options(app: Sphinx) -> None:
theme_opts = get_theme_options_dict(app)
Expand Down Expand Up @@ -150,6 +166,7 @@ def _update_theme_options(app: Sphinx) -> None:

if hasattr(app.config, "projects_version_type"):
_update_banner(flavor, app.config.projects_version_type, theme_opts)
_update_banner_rocm_ls(flavor, app.config.projects_version_type, theme_opts)

# Default the download, edit, and fullscreen buttons to off
for button in ["download", "edit_page", "fullscreen"]:
Expand Down