파일

T

히스토리

Yiltan 55aab4d62e [Docs] Clarify ROCSHMEM_HEAP_SIZE (#392 )

* clarify ROCSHMEM_HEAP_SIZE

* Apply suggestions from code review

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

---------

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

[ROCm/rocshmem commit: 0496586829]

2026-01-20 17:22:18 -05:00

api

[Docs] Clarify ROCSHMEM_HEAP_SIZE (#392 )

2026-01-20 17:22:18 -05:00

doxygen

Initial ROCm-docs (#92 )

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

sphinx

Bump rocm-docs-core to 1.31.2 (#387 )

2026-01-15 13:17:51 -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