Files
rocm-systems/projects/rocshmem/docs
Avinash Kethineedi b771a26916 Add ROCSHMEM_CTX_INVALID for invalid context handling (#287)
* Add `ROCSHMEM_CTX_INVALID` for invalid context handling
  - Define `ROCSHMEM_CTX_INVALID` as {nullptr, nullptr}
  - Add == and != operators to rocshmem_ctx_t
  - Use `ROCSHMEM_CTX_INVALID` on failed context creation
  - Skip ctx destroy if context is invalid

* Update docs for context create and destroy APIs usage and behavior

[ROCm/rocshmem commit: 955c22aeed]
2025-10-22 12:00:56 -05:00
..
2025-05-08 13:39:28 -04:00
2025-05-08 13:39:28 -04:00
2025-05-13 16:26:28 -04:00
2025-09-10 09:48:28 -04:00
2025-10-06 11:07:52 -04:00
2025-05-08 13:39:28 -04:00
2025-05-08 13:39:28 -04:00

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