Files

T

Aurelien Bouteiller 8837414042 Cleanup/wg init (#260 )

* remove wg_init and wg_finalize from functional tests

* Remove wg_init and wg_finalize from examples

* deprecate wg_init/finalize

* Updated docs

* Typo in documentation

---------

Co-authored-by: Yiltan <yiltan@amd.com>

[ROCm/rocshmem commit: 6e7277b544]

2025-10-07 14:34:18 -04:00

api

Cleanup/wg init (#260 )

2025-10-07 14:34:18 -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

Improve qp mapping (#259 )

2025-09-25 10:24:59 -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