Files

T

dependabot[bot] 166a591216 Bump urllib3 from 2.5.0 to 2.6.0 in /docs/sphinx (#365 )

Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.5.0 to 2.6.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.5.0...2.6.0)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.6.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-12-19 09:55:42 -05:00

api

GDA docs style edits (#362 )

2025-12-10 17:03:58 -05:00

doxygen

Initial ROCm-docs (#92 )

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

sphinx

Bump urllib3 from 2.5.0 to 2.6.0 in /docs/sphinx (#365 )

2025-12-19 09:55:42 -05:00

.gitignore

Initial ROCm-docs (#92 )

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

compile_and_run.rst

Fix docs rendering issue (#349 )

2025-12-08 15:54:06 -05:00

conf.py

Style edits (#122 )

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

index.rst

[Docs] Move environment variables to separate page (#341 )

2025-12-01 14:25:27 -05:00

install.rst

GDA docs style edits (#362 )

2025-12-10 17:03:58 -05: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

Fix docs rendering issue (#349 )

2025-12-08 15:54:06 -05:00

README.md

Building the rocSHMEM documentation

macOS

To build html documentation locally:

brew install doxygen sphinx-doc
pip3.10 install -r ./sphinx/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 ./sphinx/requirements.txt
sphinx-build -M latexpdf . _build
open _build/latex/rocshmem.pdf