From b072bb7c2eb9204e81fb076586041866f565c695 Mon Sep 17 00:00:00 2001 From: Peter Moutsias Date: Mon, 27 Jul 2026 19:52:15 -0400 Subject: [PATCH 1/2] fix: switch to rocm-extras flavor --- docs/conf.py | 18 +++++++++--------- docs/sphinx/requirements.in | 2 +- docs/sphinx/requirements.txt | 14 +++++--------- 3 files changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9216443d..cecd03e4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,14 +6,11 @@ import re -from rocm_docs import ROCmDocs - with open('../src/header/TransferBench.hpp', encoding='utf-8') as f: match = re.search(r'constexpr char VERSION\[\] = "([0-9.]+)[^0-9.]+', f.read()) if not match: raise ValueError("VERSION not found!") version_number = match[1] -left_nav_title = f"TransferBench {version_number} Documentation" # for PDF output on Read the Docs project = "TransferBench Documentation" @@ -24,11 +21,14 @@ external_toc_path = "./sphinx/_toc.yml" -docs_core = ROCmDocs(left_nav_title) -docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml") -docs_core.setup() +extensions = ["rocm_docs"] +html_theme = "rocm_docs_theme" +html_theme_options = { + "flavor": "rocm-extras", + "header_title": f"TransferBench {version_number}", + "header_link": f"https://rocm.docs.amd.com/projects/TransferBench/en/latest/", + "version_list_link": f"https://rocm.docs.amd.com/projects/TransferBench/en/latest/versions.html", + "link_main_doc": True, +} external_projects_current_project = "transferbench" - -for sphinx_var in ROCmDocs.SPHINX_VARS: - globals()[sphinx_var] = getattr(docs_core, sphinx_var) diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index e2b7a571..e30b1f82 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==1.31.3 +rocm-docs-core @ git+https://github.com/ROCm/rocm-docs-core.git@develop diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index e376e6c9..9490a892 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -1,9 +1,5 @@ -# -# This file is autogenerated by pip-compile with Python 3.10 -# by the following command: -# -# pip-compile requirements.in -# +# This file was autogenerated by uv via the following command: +# uv pip compile /home/pmoutsia/TransferBench/docs/sphinx/requirements.in --python-version 3.10 --output-file /home/pmoutsia/TransferBench/docs/sphinx/requirements.txt accessible-pygments==0.0.5 # via pydata-sphinx-theme alabaster==0.7.16 @@ -163,7 +159,7 @@ pygments==2.18.0 # ipython # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.8.0 +pyjwt==2.8.0 # via pygithub pynacl==1.5.0 # via pygithub @@ -188,8 +184,8 @@ requests==2.32.2 # via # pygithub # sphinx -rocm-docs-core==1.31.3 - # via -r requirements.in +rocm-docs-core @ git+https://github.com/ROCm/rocm-docs-core.git@develop + # via -r TransferBench/docs/sphinx/requirements.in rpds-py==0.22.3 # via # jsonschema From 221864550959fc756e1525d030f3c1cad86575eb Mon Sep 17 00:00:00 2001 From: Peter Moutsias Date: Mon, 27 Jul 2026 19:55:43 -0400 Subject: [PATCH 2/2] fix: suppress version list link --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index cecd03e4..899e1966 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,8 +27,7 @@ "flavor": "rocm-extras", "header_title": f"TransferBench {version_number}", "header_link": f"https://rocm.docs.amd.com/projects/TransferBench/en/latest/", - "version_list_link": f"https://rocm.docs.amd.com/projects/TransferBench/en/latest/versions.html", - "link_main_doc": True, +"link_main_doc": True, } external_projects_current_project = "transferbench"