AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add 'projects/rocshmem/' from commit '0496586829058af5cfd7f23acda2a6d0040da584'

Browse Source 
git-subtree-dir: projects/rocshmem
git-subtree-mainline: 5fd976da70
git-subtree-split: 0496586829
This commit is contained in:
Ameya Keshava Mallya
2026-01-21 20:25:37 +00:00
parent 5fd976da70 0496586829
commit 12ab8df3bc
367 changed files with 81890 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
projects/rocshmem/docs/README.md
+21
View File
@@ -0,0 +1,21 @@
# 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
```