From 92a6e820e08f525a57a6bca44bdd7772780f2e2d Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Mon, 22 Dec 2025 17:33:21 -0700 Subject: [PATCH 01/21] Move .rst files to docs/sphinx --- docs/{ => sphinx}/async.rst | 0 docs/{ => sphinx}/batch.rst | 0 docs/{ => sphinx}/config_build.rst | 0 docs/{ => sphinx}/core.rst | 0 docs/{ => sphinx}/driver.rst | 0 docs/{ => sphinx}/errors.rst | 0 docs/{ => sphinx}/file.rst | 0 docs/{ => sphinx}/introduction.rst | 0 docs/{ => sphinx}/misc_api.rst | 0 docs/{ => sphinx}/nvidia_compat.rst | 0 docs/{ => sphinx}/rdma.rst | 0 11 files changed, 0 insertions(+), 0 deletions(-) rename docs/{ => sphinx}/async.rst (100%) rename docs/{ => sphinx}/batch.rst (100%) rename docs/{ => sphinx}/config_build.rst (100%) rename docs/{ => sphinx}/core.rst (100%) rename docs/{ => sphinx}/driver.rst (100%) rename docs/{ => sphinx}/errors.rst (100%) rename docs/{ => sphinx}/file.rst (100%) rename docs/{ => sphinx}/introduction.rst (100%) rename docs/{ => sphinx}/misc_api.rst (100%) rename docs/{ => sphinx}/nvidia_compat.rst (100%) rename docs/{ => sphinx}/rdma.rst (100%) diff --git a/docs/async.rst b/docs/sphinx/async.rst similarity index 100% rename from docs/async.rst rename to docs/sphinx/async.rst diff --git a/docs/batch.rst b/docs/sphinx/batch.rst similarity index 100% rename from docs/batch.rst rename to docs/sphinx/batch.rst diff --git a/docs/config_build.rst b/docs/sphinx/config_build.rst similarity index 100% rename from docs/config_build.rst rename to docs/sphinx/config_build.rst diff --git a/docs/core.rst b/docs/sphinx/core.rst similarity index 100% rename from docs/core.rst rename to docs/sphinx/core.rst diff --git a/docs/driver.rst b/docs/sphinx/driver.rst similarity index 100% rename from docs/driver.rst rename to docs/sphinx/driver.rst diff --git a/docs/errors.rst b/docs/sphinx/errors.rst similarity index 100% rename from docs/errors.rst rename to docs/sphinx/errors.rst diff --git a/docs/file.rst b/docs/sphinx/file.rst similarity index 100% rename from docs/file.rst rename to docs/sphinx/file.rst diff --git a/docs/introduction.rst b/docs/sphinx/introduction.rst similarity index 100% rename from docs/introduction.rst rename to docs/sphinx/introduction.rst diff --git a/docs/misc_api.rst b/docs/sphinx/misc_api.rst similarity index 100% rename from docs/misc_api.rst rename to docs/sphinx/misc_api.rst diff --git a/docs/nvidia_compat.rst b/docs/sphinx/nvidia_compat.rst similarity index 100% rename from docs/nvidia_compat.rst rename to docs/sphinx/nvidia_compat.rst diff --git a/docs/rdma.rst b/docs/sphinx/rdma.rst similarity index 100% rename from docs/rdma.rst rename to docs/sphinx/rdma.rst From eb4b9fc3f95a41a884b73d33abacb27906e6c858 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 11:42:54 -0600 Subject: [PATCH 02/21] Add .readthedocs.yaml --- .readthedocs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..3afbabbc --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,18 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +sphinx: + configuration: docs/conf.py + +formats: [] + +python: + install: + - requirements: docs/sphinx/requirements.txt + +build: + os: ubuntu-22.04 + tools: + python: "3.10" From 42dae5213636a1102ea667c6c0cc1ec93a95f41c Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 14:09:09 -0600 Subject: [PATCH 03/21] Move Doxyfile.in to docs/doxygen/ --- cmake/AISDocumentation.cmake | 2 +- docs/{ => doxygen}/Doxyfile.in | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{ => doxygen}/Doxyfile.in (100%) diff --git a/cmake/AISDocumentation.cmake b/cmake/AISDocumentation.cmake index 2407978f..ecf39a68 100644 --- a/cmake/AISDocumentation.cmake +++ b/cmake/AISDocumentation.cmake @@ -24,7 +24,7 @@ if(AIS_BUILD_DOCS) set(AIS_DOXYFILE ${AIS_DOC_PATH}/Doxyfile) # Create the Doxyfile from the input file - configure_file("docs/Doxyfile.in" ${AIS_DOXYFILE}) + configure_file("docs/doxygen/Doxyfile.in" ${AIS_DOXYFILE}) # Set the output directory set(DOXYGEN_OUT ${AIS_DOC_PATH}) diff --git a/docs/Doxyfile.in b/docs/doxygen/Doxyfile.in similarity index 100% rename from docs/Doxyfile.in rename to docs/doxygen/Doxyfile.in From 3436ac4e09e6e34a1293e682a10db168a409f3c4 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 14:17:46 -0600 Subject: [PATCH 04/21] Move API Sphinx docs to docs/api --- docs/{sphinx => api}/async.rst | 0 docs/{sphinx => api}/batch.rst | 0 docs/{sphinx => api}/core.rst | 0 docs/{sphinx => api}/driver.rst | 0 docs/{sphinx => api}/errors.rst | 0 docs/{sphinx => api}/file.rst | 0 docs/{sphinx => api}/misc_api.rst | 0 docs/{sphinx => api}/rdma.rst | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename docs/{sphinx => api}/async.rst (100%) rename docs/{sphinx => api}/batch.rst (100%) rename docs/{sphinx => api}/core.rst (100%) rename docs/{sphinx => api}/driver.rst (100%) rename docs/{sphinx => api}/errors.rst (100%) rename docs/{sphinx => api}/file.rst (100%) rename docs/{sphinx => api}/misc_api.rst (100%) rename docs/{sphinx => api}/rdma.rst (100%) diff --git a/docs/sphinx/async.rst b/docs/api/async.rst similarity index 100% rename from docs/sphinx/async.rst rename to docs/api/async.rst diff --git a/docs/sphinx/batch.rst b/docs/api/batch.rst similarity index 100% rename from docs/sphinx/batch.rst rename to docs/api/batch.rst diff --git a/docs/sphinx/core.rst b/docs/api/core.rst similarity index 100% rename from docs/sphinx/core.rst rename to docs/api/core.rst diff --git a/docs/sphinx/driver.rst b/docs/api/driver.rst similarity index 100% rename from docs/sphinx/driver.rst rename to docs/api/driver.rst diff --git a/docs/sphinx/errors.rst b/docs/api/errors.rst similarity index 100% rename from docs/sphinx/errors.rst rename to docs/api/errors.rst diff --git a/docs/sphinx/file.rst b/docs/api/file.rst similarity index 100% rename from docs/sphinx/file.rst rename to docs/api/file.rst diff --git a/docs/sphinx/misc_api.rst b/docs/api/misc_api.rst similarity index 100% rename from docs/sphinx/misc_api.rst rename to docs/api/misc_api.rst diff --git a/docs/sphinx/rdma.rst b/docs/api/rdma.rst similarity index 100% rename from docs/sphinx/rdma.rst rename to docs/api/rdma.rst From b99f1fd0344827108f238ec98dc0156fd45d5e84 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 14:23:25 -0600 Subject: [PATCH 05/21] Move misc Sphinx docs to docs/ --- docs/{sphinx => }/config_build.rst | 0 docs/{sphinx => }/introduction.rst | 0 docs/{sphinx => }/nvidia_compat.rst | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/{sphinx => }/config_build.rst (100%) rename docs/{sphinx => }/introduction.rst (100%) rename docs/{sphinx => }/nvidia_compat.rst (100%) diff --git a/docs/sphinx/config_build.rst b/docs/config_build.rst similarity index 100% rename from docs/sphinx/config_build.rst rename to docs/config_build.rst diff --git a/docs/sphinx/introduction.rst b/docs/introduction.rst similarity index 100% rename from docs/sphinx/introduction.rst rename to docs/introduction.rst diff --git a/docs/sphinx/nvidia_compat.rst b/docs/nvidia_compat.rst similarity index 100% rename from docs/sphinx/nvidia_compat.rst rename to docs/nvidia_compat.rst From f22c3f1bc72d0c75cc79b14a0a77d4453f6d7793 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 14:38:00 -0600 Subject: [PATCH 06/21] Add toc and requirements Also adds a blank hipify.rst file --- docs/hipify.rst | 2 + docs/sphinx/_toc.yml | 43 ++++++ docs/sphinx/requirements.in | 1 + docs/sphinx/requirements.txt | 278 +++++++++++++++++++++++++++++++++++ 4 files changed, 324 insertions(+) create mode 100644 docs/hipify.rst create mode 100644 docs/sphinx/_toc.yml create mode 100644 docs/sphinx/requirements.in create mode 100644 docs/sphinx/requirements.txt diff --git a/docs/hipify.rst b/docs/hipify.rst new file mode 100644 index 00000000..f47bdfee --- /dev/null +++ b/docs/hipify.rst @@ -0,0 +1,2 @@ +hipify +====== diff --git a/docs/sphinx/_toc.yml b/docs/sphinx/_toc.yml new file mode 100644 index 00000000..c6fcd4eb --- /dev/null +++ b/docs/sphinx/_toc.yml @@ -0,0 +1,43 @@ +defaults: + numbered: False +root: index +subtrees: + +- entries: + - file: introduction.rst + title: Introduction + +- caption: Build and install + entries: + - file: config_build.rst + title: Configure and build + - file: sanitizers.rst + title: Sanitizers + +- caption: Using hipFile + entries: + - file: hipify.rst + title: hipify + - file: nvidia_compat.rst + title: cuFile compatibility + - file: fio.rst + title: fio support + +- caption: API reference + entries: + - file: api/errors.rst + title: Errors + - file: api/core.rst + title: Core + - file: api/driver.rst + title: Drivers + - file: api/file.rst + title: File operations + - file: api/async.rst + title: Asynchronous operatoins + - file: api/batch.rst + title: Batch operations + - file: api/rdma.rst + title: RDMA + - file: api/misc_api.rst + title: Other diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in new file mode 100644 index 00000000..aff7ac0b --- /dev/null +++ b/docs/sphinx/requirements.in @@ -0,0 +1 @@ +rocm-docs-core==1.31.2 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt new file mode 100644 index 00000000..c32119cd --- /dev/null +++ b/docs/sphinx/requirements.txt @@ -0,0 +1,278 @@ +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile requirements.in +# +accessible-pygments==0.0.5 + # via pydata-sphinx-theme +alabaster==1.0.0 + # via sphinx +asttokens==3.0.0 + # via stack-data +attrs==25.3.0 + # via + # jsonschema + # jupyter-cache + # referencing +babel==2.17.0 + # via + # pydata-sphinx-theme + # sphinx +beautifulsoup4==4.13.4 + # via pydata-sphinx-theme +breathe==4.36.0 + # via rocm-docs-core +certifi==2025.4.26 + # via requests +cffi==2.0.0 + # via + # cryptography + # pynacl +charset-normalizer==3.4.2 + # via requests +click==8.1.8 + # via + # jupyter-cache + # sphinx-external-toc +comm==0.2.2 + # via ipykernel +cryptography==44.0.3 + # via pyjwt +debugpy==1.8.14 + # via ipykernel +decorator==5.2.1 + # via ipython +deprecated==1.2.18 + # via pygithub +docutils==0.21.2 + # via + # myst-parser + # pydata-sphinx-theme + # sphinx +exceptiongroup==1.2.2 + # via ipython +executing==2.2.0 + # via stack-data +fastjsonschema==2.21.1 + # via + # nbformat + # rocm-docs-core +gitdb==4.0.12 + # via gitpython +gitpython==3.1.44 + # via rocm-docs-core +greenlet==3.2.1 + # via sqlalchemy +idna==3.10 + # via requests +imagesize==1.4.1 + # via sphinx +importlib-metadata==8.7.0 + # via + # jupyter-cache + # myst-nb +ipykernel==6.29.5 + # via myst-nb +ipython==8.36.0 + # via + # ipykernel + # myst-nb +jedi==0.19.2 + # via ipython +jinja2==3.1.6 + # via + # myst-parser + # sphinx +jsonschema==4.23.0 + # via nbformat +jsonschema-specifications==2025.4.1 + # via jsonschema +jupyter-cache==1.0.1 + # via myst-nb +jupyter-client==8.6.3 + # via + # ipykernel + # nbclient +jupyter-core==5.7.2 + # via + # ipykernel + # jupyter-client + # nbclient + # nbformat +markdown-it-py==3.0.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==3.0.2 + # via jinja2 +matplotlib-inline==0.1.7 + # via + # ipykernel + # ipython +mdit-py-plugins==0.4.2 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-nb==1.2.0 + # via rocm-docs-core +myst-parser==4.0.1 + # via myst-nb +nbclient==0.10.2 + # via + # jupyter-cache + # myst-nb +nbformat==5.10.4 + # via + # jupyter-cache + # myst-nb + # nbclient +nest-asyncio==1.6.0 + # via ipykernel +packaging==25.0 + # via + # ipykernel + # pydata-sphinx-theme + # sphinx +parso==0.8.4 + # via jedi +pexpect==4.9.0 + # via ipython +platformdirs==4.3.8 + # via jupyter-core +prompt-toolkit==3.0.51 + # via ipython +psutil==7.0.0 + # via ipykernel +ptyprocess==0.7.0 + # via pexpect +pure-eval==0.2.3 + # via stack-data +pycparser==2.22 + # via cffi +pydata-sphinx-theme==0.15.4 + # via + # rocm-docs-core + # sphinx-book-theme +pygithub==2.6.1 + # via rocm-docs-core +pygments==2.19.1 + # via + # accessible-pygments + # ipython + # pydata-sphinx-theme + # sphinx +pyjwt[crypto]==2.10.1 + # via pygithub +pynacl==1.6.2 + # via pygithub +python-dateutil==2.9.0.post0 + # via jupyter-client +pyyaml==6.0.2 + # via + # jupyter-cache + # myst-nb + # myst-parser + # rocm-docs-core + # sphinx-external-toc +pyzmq==26.4.0 + # via + # ipykernel + # jupyter-client +referencing==0.36.2 + # via + # jsonschema + # jsonschema-specifications +requests==2.32.4 + # via + # pygithub + # sphinx +rocm-docs-core==1.31.2 + # via -r requirements.in +rpds-py==0.24.0 + # via + # jsonschema + # referencing +six==1.17.0 + # via python-dateutil +smmap==5.0.2 + # via gitdb +snowballstemmer==3.0.0.1 + # via sphinx +soupsieve==2.7 + # via beautifulsoup4 +sphinx==8.1.3 + # via + # breathe + # myst-nb + # myst-parser + # pydata-sphinx-theme + # rocm-docs-core + # sphinx-book-theme + # sphinx-copybutton + # sphinx-design + # sphinx-external-toc + # sphinx-notfound-page +sphinx-book-theme==1.1.4 + # via rocm-docs-core +sphinx-copybutton==0.5.2 + # via rocm-docs-core +sphinx-design==0.6.1 + # via rocm-docs-core +sphinx-external-toc==1.0.1 + # via rocm-docs-core +sphinx-notfound-page==1.1.0 + # via rocm-docs-core +sphinxcontrib-applehelp==2.0.0 + # via sphinx +sphinxcontrib-devhelp==2.0.0 + # via sphinx +sphinxcontrib-htmlhelp==2.1.0 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==2.0.0 + # via sphinx +sphinxcontrib-serializinghtml==2.0.0 + # via sphinx +sqlalchemy==2.0.40 + # via jupyter-cache +stack-data==0.6.3 + # via ipython +tabulate==0.9.0 + # via jupyter-cache +tomli==2.2.1 + # via sphinx +tornado==6.5.1 + # via + # ipykernel + # jupyter-client +traitlets==5.14.3 + # via + # comm + # ipykernel + # ipython + # jupyter-client + # jupyter-core + # matplotlib-inline + # nbclient + # nbformat +typing-extensions==4.13.2 + # via + # beautifulsoup4 + # ipython + # myst-nb + # pydata-sphinx-theme + # pygithub + # referencing + # sqlalchemy +urllib3==2.6.3 + # via + # pygithub + # requests +wcwidth==0.2.13 + # via prompt-toolkit +wrapt==1.17.2 + # via deprecated +zipp==3.21.0 + # via importlib-metadata From 1ad60423684df04e23ff12f367d3f5c79b49c518 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 14:46:47 -0600 Subject: [PATCH 07/21] Add conf.py --- docs/conf.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..5feb5a5d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,23 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +from rocm_docs import ROCmDocs + +version_number = "0.2.0" +left_nav_title = f"hipFile {version_number} documentation" + +# for PDF output on Read the Docs +project = "hipFile" +author = "Advanced Micro Devices, Inc." +copyright = "Copyright (c) Advanced Micro Devices, Inc. All rights reserved." +version = version_number +release = version_number + +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() From 4c8b45a8fe0a0ff9738a63d6484a3ac68088213c Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 15:32:40 -0600 Subject: [PATCH 08/21] Fixes that make Sphinx "work" --- docs/conf.py | 6 +++- docs/index.rst | 42 +++++++++++++++++++++++++++ docs/sphinx/{_toc.yml => _toc.yml.in} | 2 +- 3 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 docs/index.rst rename docs/sphinx/{_toc.yml => _toc.yml.in} (95%) diff --git a/docs/conf.py b/docs/conf.py index 5feb5a5d..de844a56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,7 +10,7 @@ left_nav_title = f"hipFile {version_number} documentation" # for PDF output on Read the Docs -project = "hipFile" +project = "rocSHMEM" author = "Advanced Micro Devices, Inc." copyright = "Copyright (c) Advanced Micro Devices, Inc. All rights reserved." version = version_number @@ -21,3 +21,7 @@ docs_core = ROCmDocs(left_nav_title) docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml") docs_core.setup() + +external_projects_current_project = "rocshmem" +for sphinx_var in ROCmDocs.SPHINX_VARS: + globals()[sphinx_var] = getattr(docs_core, sphinx_var) diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..e1303d1b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,42 @@ +.. meta:: + :description: hipFile does hipFile stuff + :keywords: hipFile, ROCm, storage, library, API, DMA + +**************************** +rocSHMEM documentation +**************************** + +hipFile introduction goes here. For more information, see :doc:`introduction`. + +The hipFile public repository is located at ``_. + +.. grid:: 2 + :gutter: 3 + + .. grid-item-card:: Build and install + + * :doc:`Configure and build <./config_build>` + * :doc:`Sanitizers <./sanitizers>` + + .. grid-item-card:: Using hipFile + + * :doc:`hipify <./hipify>` + * :doc:`NVIDIA compatibility <./nvidia_compat>` + * :doc:`fio <./fio>` + + .. grid-item-card:: API reference + + * :doc:`Errors <./api/errors>` + * :doc:`Core API<./api/core>` + * :doc:`Drivers <./api/driver>` + * :doc:`File operations <./api/file>` + * :doc:`Asynchronous operations <./api/async>` + * :doc:`Batch operations <./api/batch>` + * :doc:`RDMA <./api/rdma>` + * :doc:`Other <./api/misc_api>` + +To contribute to the documentation, refer to +`Contributing to ROCm `_. + +You can find licensing information on the +`Licensing `_ page. diff --git a/docs/sphinx/_toc.yml b/docs/sphinx/_toc.yml.in similarity index 95% rename from docs/sphinx/_toc.yml rename to docs/sphinx/_toc.yml.in index c6fcd4eb..930411f6 100644 --- a/docs/sphinx/_toc.yml +++ b/docs/sphinx/_toc.yml.in @@ -34,7 +34,7 @@ subtrees: - file: api/file.rst title: File operations - file: api/async.rst - title: Asynchronous operatoins + title: Asynchronous operations - file: api/batch.rst title: Batch operations - file: api/rdma.rst From ce138737150aff09264927797823b938847a7b5b Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Tue, 17 Mar 2026 15:37:18 -0600 Subject: [PATCH 09/21] Add stats_collection to Sphinx --- docs/index.rst | 1 + docs/sphinx/_toc.yml.in | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index e1303d1b..fbba6d4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,7 @@ The hipFile public repository is located at ``_ * :doc:`hipify <./hipify>` * :doc:`NVIDIA compatibility <./nvidia_compat>` * :doc:`fio <./fio>` + * :doc:`Collecting statistics <./stats_collection>` .. grid-item-card:: API reference diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 930411f6..c4d32d37 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -22,6 +22,8 @@ subtrees: title: cuFile compatibility - file: fio.rst title: fio support + - file: stats_collection.rst + title: Collecting statistics - caption: API reference entries: From 4d0fa1a9d8ece23f9f5fe2819835e0be48ea7b51 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:05:31 -0600 Subject: [PATCH 10/21] Fix index.rst rocSHMEM comment --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index fbba6d4c..ef2f7cf3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,9 +2,9 @@ :description: hipFile does hipFile stuff :keywords: hipFile, ROCm, storage, library, API, DMA -**************************** -rocSHMEM documentation -**************************** +********************* +hipFile documentation +********************* hipFile introduction goes here. For more information, see :doc:`introduction`. From bb6f6b4cff6a551761bacbbbdf8873b99d1acb2a Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:06:24 -0600 Subject: [PATCH 11/21] Fix missing space in index.rst --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index ef2f7cf3..73c3ef1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,7 +28,7 @@ The hipFile public repository is located at ``_ .. grid-item-card:: API reference * :doc:`Errors <./api/errors>` - * :doc:`Core API<./api/core>` + * :doc:`Core API <./api/core>` * :doc:`Drivers <./api/driver>` * :doc:`File operations <./api/file>` * :doc:`Asynchronous operations <./api/async>` From ad76affa39b31684da8a0fb8aec5d03ea4d06c5f Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:10:51 -0600 Subject: [PATCH 12/21] Add a comment block to _toc.yml.in --- docs/sphinx/_toc.yml.in | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index c4d32d37..1fcaff2e 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -1,3 +1,7 @@ +# This file is a template for the Sphinx table of contents. +# A build step is expected to generate `_toc.yml` from this `_toc.yml.in` +# file before running the Sphinx build (see docs/conf.py configuration). + defaults: numbered: False root: index From a7029f6cdcc0f1670aa7ff7c89abd425877ecc6c Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:13:00 -0600 Subject: [PATCH 13/21] Fix correctness and formatting in .readthedocs.yaml --- .readthedocs.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3afbabbc..f35d5c2f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,15 +4,15 @@ version: 2 sphinx: - configuration: docs/conf.py + configuration: docs/conf.py formats: [] python: - install: - - requirements: docs/sphinx/requirements.txt + install: + - requirements: docs/sphinx/requirements.txt build: - os: ubuntu-22.04 - tools: - python: "3.10" + os: ubuntu-22.04 + tools: + python: "3.10" From 683372d14ff882839bde8a6c440fd95505eaca75 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:20:57 -0600 Subject: [PATCH 14/21] Suppress pylint complaints on conf.py --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index de844a56..f83db6b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,6 +4,11 @@ # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +# Pylint is NOT happy with the naming scheme ROCm chose +# pylint: disable=invalid-name + +"""This file is for configuring hipFile documentation""" + from rocm_docs import ROCmDocs version_number = "0.2.0" @@ -12,7 +17,9 @@ # for PDF output on Read the Docs project = "rocSHMEM" author = "Advanced Micro Devices, Inc." +# pylint: disable=redefined-builtin copyright = "Copyright (c) Advanced Micro Devices, Inc. All rights reserved." +# pylint: enable=redefined-builtin version = version_number release = version_number From dbb58b80fb9b9f7ed8b5932e484b0baee1c57616 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:48:22 -0600 Subject: [PATCH 15/21] Add rocm_docs to pip list --- .github/workflows/pylint.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index 27311aed..5e3492bb 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -18,11 +18,12 @@ jobs: - name: Set up Python uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 #v6.2.0 - - name: Set up pylint and black + - name: Install packages run: | python -m pip install --upgrade pip python -m pip install pylint python -m pip install black + python -m pip install rocm_docs - name: Lint all Python files run: | From 3a4e70bda7c9fb8e1e8034be55707142d97eecf6 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 11:51:48 -0600 Subject: [PATCH 16/21] Fix rocm_docs package typo --- .github/workflows/pylint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml index 5e3492bb..e0606ca1 100644 --- a/.github/workflows/pylint.yml +++ b/.github/workflows/pylint.yml @@ -23,7 +23,7 @@ jobs: python -m pip install --upgrade pip python -m pip install pylint python -m pip install black - python -m pip install rocm_docs + python -m pip install rocm-docs-core - name: Lint all Python files run: | From fc9c85352fa6b23840035edc965b7b8f484d40c8 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 14:51:32 -0600 Subject: [PATCH 17/21] First cut at moving sphinx generation to CMake --- cmake/AISDocumentation.cmake | 58 +++++- docs/doxygen/Doxyfile.in | 2 +- docs/sphinx/{_toc.yml.in => _toc.yml} | 4 - docs/{ => sphinx}/conf.py | 17 +- docs/sphinx/requirements.in | 1 - docs/sphinx/requirements.txt | 278 -------------------------- 6 files changed, 64 insertions(+), 296 deletions(-) rename docs/sphinx/{_toc.yml.in => _toc.yml} (81%) rename docs/{ => sphinx}/conf.py (68%) delete mode 100644 docs/sphinx/requirements.in delete mode 100644 docs/sphinx/requirements.txt diff --git a/cmake/AISDocumentation.cmake b/cmake/AISDocumentation.cmake index ecf39a68..68787f92 100644 --- a/cmake/AISDocumentation.cmake +++ b/cmake/AISDocumentation.cmake @@ -13,28 +13,66 @@ option(AIS_BUILD_DOCS "Build the hipFile docs (requires Doxygen, Sphinx, and Bre if(AIS_BUILD_DOCS) find_package(Doxygen REQUIRED) + find_package(Python3 REQUIRED COMPONENTS Interpreter) + + # Verify Sphinx + rocm_docs are available + execute_process( + COMMAND "${Python3_EXECUTABLE}" -c "import rocm_docs" + RESULT_VARIABLE _rocm_docs_found + OUTPUT_QUIET ERROR_QUIET + ) + if(NOT _rocm_docs_found EQUAL 0) + message(FATAL_ERROR "rocm_docs Python package not found. Install it with: pip install rocm-docs-core") + endif() # Set Doxygen input (pasted into Doxyfile.in) set(AIS_DOXYFILE_INPUT "${HIPFILE_ROOT_PATH}/include") - + # Set the path to the documentation set(AIS_DOC_PATH "${CMAKE_CURRENT_BINARY_DIR}/docs") - + # Set the Doxyfile install location - set(AIS_DOXYFILE ${AIS_DOC_PATH}/Doxyfile) + set(AIS_DOXYFILE "${AIS_DOC_PATH}/doxygen/Doxyfile") + + # Doxygen XML output dir (consumed by Breathe inside Sphinx) + set(AIS_DOXYGEN_XML_DIR "${AIS_DOC_PATH}/doxygen/xml") # Create the Doxyfile from the input file configure_file("docs/doxygen/Doxyfile.in" ${AIS_DOXYFILE}) - # Set the output directory - set(DOXYGEN_OUT ${AIS_DOC_PATH}) + # Sphinx HTML output dir + set(AIS_SPHINX_BUILD_DIR "${AIS_DOC_PATH}/html") - # Configure the documentation build - add_custom_target("doc" - COMMAND ${DOXYGEN_EXECUTABLE} ${AIS_DOXYFILE} - WORKING_DIRECTORY ${AIS_DOC_PATH} - COMMENT "Generating hipFile API documentation with Doxygen" + # Build docs: Doxygen first, then Sphinx (which pulls in rocm_docs via conf.py) + add_custom_target(doc + # Step 1: Run Doxygen to produce XML for Breathe + COMMAND "${DOXYGEN_EXECUTABLE}" "${AIS_DOXYFILE}" + # Step 2: Run Sphinx, injecting the Doxygen paths via environment + COMMAND + ${CMAKE_COMMAND} -E env + "DOXYFILE_PATH=${AIS_DOXYFILE}" + "DOXYGEN_ROOT=${AIS_DOC_PATH}/doxygen" + "DOXYGEN_XML_DIR=${AIS_DOXYGEN_XML_DIR}" + "${Python3_EXECUTABLE}" -m sphinx + -b html + -C + -c "${CMAKE_CURRENT_SOURCE_DIR}/docs/sphinx" + "${CMAKE_CURRENT_SOURCE_DIR}/docs" + "${AIS_SPHINX_BUILD_DIR}" + WORKING_DIRECTORY "${AIS_DOC_PATH}" + COMMENT "Generating hipFile API documentation with Doxygen + Sphinx (rocm_docs)" VERBATIM ) + # Set the output directory + #set(DOXYGEN_OUT ${AIS_DOC_PATH}) + + # Configure the documentation build + #add_custom_target("doc" + # COMMAND ${DOXYGEN_EXECUTABLE} ${AIS_DOXYFILE} + # WORKING_DIRECTORY ${AIS_DOC_PATH} + # COMMENT "Generating hipFile API documentation with Doxygen" + # VERBATIM + #) + endif() diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index ad39635e..47b2b360 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -68,7 +68,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = @AIS_DOC_PATH@/doxygen # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml similarity index 81% rename from docs/sphinx/_toc.yml.in rename to docs/sphinx/_toc.yml index 1fcaff2e..c4d32d37 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml @@ -1,7 +1,3 @@ -# This file is a template for the Sphinx table of contents. -# A build step is expected to generate `_toc.yml` from this `_toc.yml.in` -# file before running the Sphinx build (see docs/conf.py configuration). - defaults: numbered: False root: index diff --git a/docs/conf.py b/docs/sphinx/conf.py similarity index 68% rename from docs/conf.py rename to docs/sphinx/conf.py index f83db6b4..59382e09 100644 --- a/docs/conf.py +++ b/docs/sphinx/conf.py @@ -9,6 +9,7 @@ """This file is for configuring hipFile documentation""" +import os from rocm_docs import ROCmDocs version_number = "0.2.0" @@ -22,13 +23,25 @@ # pylint: enable=redefined-builtin version = version_number release = version_number +external_projects_current_project = "rocshmem" external_toc_path = "./sphinx/_toc.yml" docs_core = ROCmDocs(left_nav_title) -docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml") + +doxygen_root = os.environ.get("DOXYGEN_ROOT") +doxygen_xml_dir = os.environ.get("DOXYGEN_XML_DIR") + +if not doxygen_root or not doxygen_xml_dir: + raise RuntimeError( + "DOXYGEN_ROOT and DOXYGEN_XML_DIR must be set. " + "Build this documentation via CMake, not directly with sphinx-build." + ) + +docs_core.run_doxygen(doxygen_root=doxygen_root, doxygen_path=doxygen_xml_dir) + docs_core.setup() -external_projects_current_project = "rocshmem" +# Transfer all Sphinx config variables into this module's global scope 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 deleted file mode 100644 index aff7ac0b..00000000 --- a/docs/sphinx/requirements.in +++ /dev/null @@ -1 +0,0 @@ -rocm-docs-core==1.31.2 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt deleted file mode 100644 index c32119cd..00000000 --- a/docs/sphinx/requirements.txt +++ /dev/null @@ -1,278 +0,0 @@ -# -# This file is autogenerated by pip-compile with Python 3.10 -# by the following command: -# -# pip-compile requirements.in -# -accessible-pygments==0.0.5 - # via pydata-sphinx-theme -alabaster==1.0.0 - # via sphinx -asttokens==3.0.0 - # via stack-data -attrs==25.3.0 - # via - # jsonschema - # jupyter-cache - # referencing -babel==2.17.0 - # via - # pydata-sphinx-theme - # sphinx -beautifulsoup4==4.13.4 - # via pydata-sphinx-theme -breathe==4.36.0 - # via rocm-docs-core -certifi==2025.4.26 - # via requests -cffi==2.0.0 - # via - # cryptography - # pynacl -charset-normalizer==3.4.2 - # via requests -click==8.1.8 - # via - # jupyter-cache - # sphinx-external-toc -comm==0.2.2 - # via ipykernel -cryptography==44.0.3 - # via pyjwt -debugpy==1.8.14 - # via ipykernel -decorator==5.2.1 - # via ipython -deprecated==1.2.18 - # via pygithub -docutils==0.21.2 - # via - # myst-parser - # pydata-sphinx-theme - # sphinx -exceptiongroup==1.2.2 - # via ipython -executing==2.2.0 - # via stack-data -fastjsonschema==2.21.1 - # via - # nbformat - # rocm-docs-core -gitdb==4.0.12 - # via gitpython -gitpython==3.1.44 - # via rocm-docs-core -greenlet==3.2.1 - # via sqlalchemy -idna==3.10 - # via requests -imagesize==1.4.1 - # via sphinx -importlib-metadata==8.7.0 - # via - # jupyter-cache - # myst-nb -ipykernel==6.29.5 - # via myst-nb -ipython==8.36.0 - # via - # ipykernel - # myst-nb -jedi==0.19.2 - # via ipython -jinja2==3.1.6 - # via - # myst-parser - # sphinx -jsonschema==4.23.0 - # via nbformat -jsonschema-specifications==2025.4.1 - # via jsonschema -jupyter-cache==1.0.1 - # via myst-nb -jupyter-client==8.6.3 - # via - # ipykernel - # nbclient -jupyter-core==5.7.2 - # via - # ipykernel - # jupyter-client - # nbclient - # nbformat -markdown-it-py==3.0.0 - # via - # mdit-py-plugins - # myst-parser -markupsafe==3.0.2 - # via jinja2 -matplotlib-inline==0.1.7 - # via - # ipykernel - # ipython -mdit-py-plugins==0.4.2 - # via myst-parser -mdurl==0.1.2 - # via markdown-it-py -myst-nb==1.2.0 - # via rocm-docs-core -myst-parser==4.0.1 - # via myst-nb -nbclient==0.10.2 - # via - # jupyter-cache - # myst-nb -nbformat==5.10.4 - # via - # jupyter-cache - # myst-nb - # nbclient -nest-asyncio==1.6.0 - # via ipykernel -packaging==25.0 - # via - # ipykernel - # pydata-sphinx-theme - # sphinx -parso==0.8.4 - # via jedi -pexpect==4.9.0 - # via ipython -platformdirs==4.3.8 - # via jupyter-core -prompt-toolkit==3.0.51 - # via ipython -psutil==7.0.0 - # via ipykernel -ptyprocess==0.7.0 - # via pexpect -pure-eval==0.2.3 - # via stack-data -pycparser==2.22 - # via cffi -pydata-sphinx-theme==0.15.4 - # via - # rocm-docs-core - # sphinx-book-theme -pygithub==2.6.1 - # via rocm-docs-core -pygments==2.19.1 - # via - # accessible-pygments - # ipython - # pydata-sphinx-theme - # sphinx -pyjwt[crypto]==2.10.1 - # via pygithub -pynacl==1.6.2 - # via pygithub -python-dateutil==2.9.0.post0 - # via jupyter-client -pyyaml==6.0.2 - # via - # jupyter-cache - # myst-nb - # myst-parser - # rocm-docs-core - # sphinx-external-toc -pyzmq==26.4.0 - # via - # ipykernel - # jupyter-client -referencing==0.36.2 - # via - # jsonschema - # jsonschema-specifications -requests==2.32.4 - # via - # pygithub - # sphinx -rocm-docs-core==1.31.2 - # via -r requirements.in -rpds-py==0.24.0 - # via - # jsonschema - # referencing -six==1.17.0 - # via python-dateutil -smmap==5.0.2 - # via gitdb -snowballstemmer==3.0.0.1 - # via sphinx -soupsieve==2.7 - # via beautifulsoup4 -sphinx==8.1.3 - # via - # breathe - # myst-nb - # myst-parser - # pydata-sphinx-theme - # rocm-docs-core - # sphinx-book-theme - # sphinx-copybutton - # sphinx-design - # sphinx-external-toc - # sphinx-notfound-page -sphinx-book-theme==1.1.4 - # via rocm-docs-core -sphinx-copybutton==0.5.2 - # via rocm-docs-core -sphinx-design==0.6.1 - # via rocm-docs-core -sphinx-external-toc==1.0.1 - # via rocm-docs-core -sphinx-notfound-page==1.1.0 - # via rocm-docs-core -sphinxcontrib-applehelp==2.0.0 - # via sphinx -sphinxcontrib-devhelp==2.0.0 - # via sphinx -sphinxcontrib-htmlhelp==2.1.0 - # via sphinx -sphinxcontrib-jsmath==1.0.1 - # via sphinx -sphinxcontrib-qthelp==2.0.0 - # via sphinx -sphinxcontrib-serializinghtml==2.0.0 - # via sphinx -sqlalchemy==2.0.40 - # via jupyter-cache -stack-data==0.6.3 - # via ipython -tabulate==0.9.0 - # via jupyter-cache -tomli==2.2.1 - # via sphinx -tornado==6.5.1 - # via - # ipykernel - # jupyter-client -traitlets==5.14.3 - # via - # comm - # ipykernel - # ipython - # jupyter-client - # jupyter-core - # matplotlib-inline - # nbclient - # nbformat -typing-extensions==4.13.2 - # via - # beautifulsoup4 - # ipython - # myst-nb - # pydata-sphinx-theme - # pygithub - # referencing - # sqlalchemy -urllib3==2.6.3 - # via - # pygithub - # requests -wcwidth==0.2.13 - # via prompt-toolkit -wrapt==1.17.2 - # via deprecated -zipp==3.21.0 - # via importlib-metadata From 371ac3a23ef00eaa76ca9bc273fa11c89a919bbd Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 16:00:54 -0600 Subject: [PATCH 18/21] Fixed a lot of CMake issues --- cmake/AISDocumentation.cmake | 17 +++-------------- docs/sphinx/{_toc.yml => _toc.yml.in} | 0 docs/sphinx/conf.py | 1 + docs/stats_collection.rst | 8 +++----- 4 files changed, 7 insertions(+), 19 deletions(-) rename docs/sphinx/{_toc.yml => _toc.yml.in} (100%) diff --git a/cmake/AISDocumentation.cmake b/cmake/AISDocumentation.cmake index 68787f92..d78a5714 100644 --- a/cmake/AISDocumentation.cmake +++ b/cmake/AISDocumentation.cmake @@ -55,24 +55,13 @@ if(AIS_BUILD_DOCS) "DOXYGEN_XML_DIR=${AIS_DOXYGEN_XML_DIR}" "${Python3_EXECUTABLE}" -m sphinx -b html - -C - -c "${CMAKE_CURRENT_SOURCE_DIR}/docs/sphinx" - "${CMAKE_CURRENT_SOURCE_DIR}/docs" + -c "${HIPFILE_ROOT_PATH}/docs/sphinx" + "${HIPFILE_ROOT_PATH}/docs" "${AIS_SPHINX_BUILD_DIR}" + -v WORKING_DIRECTORY "${AIS_DOC_PATH}" COMMENT "Generating hipFile API documentation with Doxygen + Sphinx (rocm_docs)" VERBATIM ) - # Set the output directory - #set(DOXYGEN_OUT ${AIS_DOC_PATH}) - - # Configure the documentation build - #add_custom_target("doc" - # COMMAND ${DOXYGEN_EXECUTABLE} ${AIS_DOXYFILE} - # WORKING_DIRECTORY ${AIS_DOC_PATH} - # COMMENT "Generating hipFile API documentation with Doxygen" - # VERBATIM - #) - endif() diff --git a/docs/sphinx/_toc.yml b/docs/sphinx/_toc.yml.in similarity index 100% rename from docs/sphinx/_toc.yml rename to docs/sphinx/_toc.yml.in diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 59382e09..08d425be 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -45,3 +45,4 @@ # Transfer all Sphinx config variables into this module's global scope for sphinx_var in ROCmDocs.SPHINX_VARS: globals()[sphinx_var] = getattr(docs_core, sphinx_var) +extensions.append('sphinx_design') diff --git a/docs/stats_collection.rst b/docs/stats_collection.rst index e9d5e597..5c1b563e 100644 --- a/docs/stats_collection.rst +++ b/docs/stats_collection.rst @@ -4,10 +4,8 @@ Stats Collection Tool Command-line Tool ----------------- ``ais-stats`` can be run two ways: -* ``$ ais-stats -p [-i]`` will collect stats from a running process. - ``-i`` will report immediately rather than wait for the process to exit. -* ``$ ais-stats [args...]`` will launch ```` with the - provided arguments and report the collected stats when it exits. +* ``$ ais-stats -p [-i]`` will collect stats from a running process. ``-i`` will report immediately rather than wait for the process to exit. +* ``$ ais-stats [args...]`` will launch ```` with the provided arguments and report the collected stats when it exits. Configuration ------------- @@ -24,4 +22,4 @@ Value Description Stats Collected --------------- * Basic: Bytes read/written on the fastpath backend -* Basic: Bytes read/written on the fallback backend \ No newline at end of file +* Basic: Bytes read/written on the fallback backend From 722d08a1dd6fd8754e642603d3c615c5902022c7 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 19:35:31 -0600 Subject: [PATCH 19/21] Fix cmakelint issues --- cmake/AISDocumentation.cmake | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmake/AISDocumentation.cmake b/cmake/AISDocumentation.cmake index d78a5714..17063ae1 100644 --- a/cmake/AISDocumentation.cmake +++ b/cmake/AISDocumentation.cmake @@ -27,10 +27,10 @@ if(AIS_BUILD_DOCS) # Set Doxygen input (pasted into Doxyfile.in) set(AIS_DOXYFILE_INPUT "${HIPFILE_ROOT_PATH}/include") - + # Set the path to the documentation set(AIS_DOC_PATH "${CMAKE_CURRENT_BINARY_DIR}/docs") - + # Set the Doxyfile install location set(AIS_DOXYFILE "${AIS_DOC_PATH}/doxygen/Doxyfile") From e662d83888cf348fee66a0b6a56a627f84e40c5c Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 19:38:10 -0600 Subject: [PATCH 20/21] Fix pylint issues --- docs/sphinx/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index 08d425be..a77e2530 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -24,7 +24,7 @@ version = version_number release = version_number external_projects_current_project = "rocshmem" - +extensions = ['sphinx_design'] external_toc_path = "./sphinx/_toc.yml" docs_core = ROCmDocs(left_nav_title) @@ -45,4 +45,3 @@ # Transfer all Sphinx config variables into this module's global scope for sphinx_var in ROCmDocs.SPHINX_VARS: globals()[sphinx_var] = getattr(docs_core, sphinx_var) -extensions.append('sphinx_design') From e358e9577c24bf7aeef0d4976dc0b330a86b1b56 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Wed, 18 Mar 2026 21:55:11 -0600 Subject: [PATCH 21/21] Fix quotes on conf.py --- docs/sphinx/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index a77e2530..52c5f78e 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -24,7 +24,7 @@ version = version_number release = version_number external_projects_current_project = "rocshmem" -extensions = ['sphinx_design'] +extensions = ["sphinx_design"] external_toc_path = "./sphinx/_toc.yml" docs_core = ROCmDocs(left_nav_title)