derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
66 lines
1.1 KiB
Markdown
66 lines
1.1 KiB
Markdown
# Building the rocSHMEM documentation
|
|
|
|
## Prerequisites
|
|
|
|
- Python 3.10+
|
|
- [Doxygen](https://www.doxygen.nl/)
|
|
|
|
## Linux
|
|
|
|
Install system dependencies:
|
|
|
|
```bash
|
|
sudo apt-get install -y doxygen
|
|
```
|
|
|
|
Install Python dependencies:
|
|
|
|
```bash
|
|
pip3 install -r ./sphinx/requirements.txt
|
|
```
|
|
|
|
Build HTML documentation:
|
|
|
|
```bash
|
|
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
|
|
```
|
|
|
|
Open the generated docs:
|
|
|
|
```bash
|
|
xdg-open _build/html/index.html
|
|
```
|
|
|
|
### Building to a custom output directory
|
|
|
|
```bash
|
|
python3 -m sphinx -T -E -b html -d <output-dir>/doctrees -D language=en . <output-dir>/html
|
|
```
|
|
|
|
## macOS
|
|
|
|
Install system dependencies:
|
|
|
|
```bash
|
|
brew install doxygen sphinx-doc
|
|
```
|
|
|
|
Install Python dependencies and build:
|
|
|
|
```bash
|
|
pip3 install -r ./sphinx/requirements.txt
|
|
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
|
|
open _build/html/index.html
|
|
```
|
|
|
|
## PDF output
|
|
|
|
PDF output requires a LaTeX installation (e.g. `texlive-full` on Linux, MacTeX on macOS).
|
|
|
|
```bash
|
|
pip3 install -r ./sphinx/requirements.txt
|
|
sphinx-build -M latexpdf . _build
|
|
```
|
|
|
|
The PDF is written to `_build/latex/rocshmem.pdf`.
|