2025-05-08 13:39:28 -04:00
|
|
|
# Building the rocSHMEM documentation
|
|
|
|
|
|
|
|
|
|
## macOS
|
|
|
|
|
|
|
|
|
|
To build html documentation locally:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
brew install doxygen sphinx-doc
|
2025-12-08 15:54:06 -05:00
|
|
|
pip3.10 install -r ./sphinx/requirements.txt
|
2025-05-08 13:39:28 -04:00
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```
|
2025-12-08 15:54:06 -05:00
|
|
|
pip3.10 install -r ./sphinx/requirements.txt
|
2025-05-08 13:39:28 -04:00
|
|
|
sphinx-build -M latexpdf . _build
|
|
|
|
|
open _build/latex/rocshmem.pdf
|
|
|
|
|
```
|
