Skip to content

fix: switch to rocm-extras flavor #346

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 1 commit into from
Jul 28, 2026
Merged

fix: switch to rocm-extras flavor #346

Show file tree
Hide file tree
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
31 changes: 7 additions & 24 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import re

from rocm_docs import ROCmDocs

version_number = "1.66.02"
left_nav_title = f"TransferBench {version_number} Documentation"

# for PDF output on Read the Docs
project = "TransferBench Documentation"
Expand All @@ -20,25 +15,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()

external_projects_current_project = "transferbench"

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

extensions = ["rocm_docs"]
html_theme = "rocm_docs_theme"
html_theme_options = {
"flavor": "generic",
"header_title": f"ROCm™ TransferBench 1.66.02",
"flavor": "rocm-extras",
"header_title": f"ROCm™ TransferBench {version_number}",
"header_link": f"https://rocm.docs.amd.com/projects/TransferBench/en/docs-1.66.02/",
"nav_secondary_items": {
"GitHub": "https://github.com/ROCm/TransferBench",
"Community": "https://github.com/ROCm/ROCm/discussions",
"Blogs": "https://rocm.blogs.amd.com/",
"System and Infra Docs": "https://instinct.docs.amd.com/",
"Support": "https://github.com/ROCm/TransferBench/issues/new/choose",
},
"link_main_doc": False,
"link_main_doc": True,
}

external_projects_current_project = "transferbench"
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