Files

T

Yiltan 9338c84480 Updated docs for ROCm 7.x.x (#239 )

Co-authored-by: Aurelien Bouteiller <aurelien.bouteiller@amd.com>
Co-authored-by: yugang-amd <yugang.wang@amd.com>

2025-10-17 12:10:37 -04:00

api

Updated docs for ROCm 7.x.x (#239 )

2025-10-17 12:10:37 -04:00

doxygen

Initial ROCm-docs (#92 )

2025-05-08 13:39:28 -04:00

sphinx

Bump urllib3 from 2.4.0 to 2.5.0 in /docs/sphinx (#170 )

2025-06-25 11:08:42 -04:00

.gitignore

Initial ROCm-docs (#92 )

2025-05-08 13:39:28 -04:00

compile_and_run.rst

Make ROCSHMEM_DISABLE_MIXED_IPC a synonym for ROCSHMEM_RO_DISABLE_IPC, ROCSHMEM_DISABLE_IPC (#273 )

2025-10-09 19:57:53 -04:00

conf.py

Style edits (#122 )

2025-05-13 16:26:28 -04:00

index.rst

remove broken link etc. (#234 )

2025-09-10 09:48:28 -04:00

install.rst

Update descriptions about hardware support (#236 )

2025-09-08 13:26:05 -04:00

introduction.rst

remove dead link (#271 )

2025-10-06 11:07:52 -04:00

license.md

Initial ROCm-docs (#92 )

2025-05-08 13:39:28 -04:00

README.md

Initial ROCm-docs (#92 )

2025-05-08 13:39:28 -04:00

README.md

Building the rocSHMEM documentation

macOS

To build html documentation locally:

brew install doxygen sphinx-doc
pip3.10 install -r ./requirements.txt
python3.10 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
open _build/html/index.html

To build pdf documentation we require a LaTeX installation on your machine. Once LaTeX is installed, you may run the following:

pip3.10 install -r ./requirements.txt
sphinx-build -M latexpdf . _build
open _build/latex/rocshmem.pdf