Files

T

Aurelien Bouteiller 93cf1b680e Documentation for RO (#189 )

* Update documentation to include RO and how to use it

* Clarify supported configuration

Co-authored-by: yugang-amd <yugang.wang@amd.com>


[ROCm/rocshmem commit: 42e28835ad]

2025-07-10 18:49:10 -04:00

api

Refactor Barrier_all and Sync_all APIs to use default context (#159 )

2025-06-17 11:16:18 -05: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

Documentation for RO (#189 )

2025-07-10 18:49:10 -04:00

conf.py

Style edits (#122 )

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

index.rst

Final edits (#126 )

2025-05-21 16:59:00 -04:00

install.rst

Documentation for RO (#189 )

2025-07-10 18:49:10 -04:00

introduction.rst

Final edits (#126 )

2025-05-21 16:59:00 -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