Files

T

dependabot[bot] 47bd7ec0d8 Bump urllib3 from 2.4.0 to 2.5.0 in /docs/sphinx (#170 )

Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.4.0 to 2.5.0.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](https://github.com/urllib3/urllib3/compare/2.4.0...2.5.0)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.5.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

2025-06-25 11:08:42 -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

Introduce support for executing the IPC conduit without MPI (#153 )

2025-06-21 13:23:11 -05: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

Final edits (#126 )

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