Skip to content

fix: switch to rocm-extras flavor #345

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
pmoutsias-amd merged 2 commits into from
Jul 28, 2026
Merged

fix: switch to rocm-extras flavor #345

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
b072bb7
fix: switch to rocm-extras flavor
pmoutsias-amd Jul 27, 2026
2218645
fix: suppress version list link
pmoutsias-amd Jul 27, 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
17 changes: 8 additions & 9 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -24,11 +21,13 @@

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/",
"link_main_doc": True,
}

external_projects_current_project = "transferbench"

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
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 +1 @@
rocm-docs-core==1.31.3
rocm-docs-core @ git+https://github.com/ROCm/rocm-docs-core.git@develop
14 changes: 5 additions & 9 deletions docs/sphinx/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading