Merge pull request #769 from samjwu/cherry-pick

Cherry pick documentation dependency updates for rocm release 5.6 branch
ROCm · Jun 14, 2023 · 3dcebc7 · 3dcebc7
2 parents f7c1a0e + f0bd307
commit 3dcebc7
Show file tree

Hide file tree

Showing 13 changed files with 197 additions and 303 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,12 @@
 version: 2
 updates:
   - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/docs/.sphinx" # Location of package manifests
+    directory: "/docs/sphinx" # Location of package manifests
     open-pull-requests-limit: 10
     schedule:
       interval: "daily"
+    labels:
+      - "dependencies"
+      - "noCI"
+    reviewers:
+      - "samjwu"
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ _static/
 _templates/
 _toc.yml
 docBin/
+_doxygen/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,12 +3,16 @@
 
 version: 2
 
+build:
+   os: ubuntu-22.04
+   tools:
+      python: "3.8"
+
 sphinx:
    configuration: docs/conf.py
 
-formats: [htmlzip]
+formats: [htmlzip, pdf, epub]
 
 python:
-   version: "3.8"
    install:
-   - requirements: docs/.sphinx/requirements.txt
+   - requirements: docs/sphinx/requirements.txt
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ The root of this repository has a helper script 'install.sh' to build and instal
 *  `./install.sh  --npkit-enable` -- enable compilation of npkit profiler framework with all options
 
 ## Manual build
+
 ### To build the library :
 
 ```shell
@@ -61,18 +62,8 @@ $ sudo dpkg -i *.deb
 
 RCCL package install requires sudo/root access because it creates a directory called "rccl" under /opt/rocm/. This is an optional step and RCCL can be used directly by including the path containing librccl.so.
 
-### How to build documentation
-Please follow the instructions below to build the documentation.
-```bash
-cd docs
-
-pip3 install -r .sphinx/requirements.txt
-
-python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
-```
-
-
 ## Enabling peer-to-peer transport
+
 In order to enable peer-to-peer access on machines with PCIe-connected GPUs, the HSA environment variable HSA_FORCE_FINE_GRAIN_PCIE=1 is required to be set, on top of requiring GPUs that support peer-to-peer access and proper large BAR addressing support.
 
 ## Tests
@@ -109,7 +100,7 @@ To manually analyze NPKit dump results, please leverage [npkit_trace_generator.p
 
 ## Library and API Documentation
 
-Please refer to the [Library documentation](https://rccl.readthedocs.io/) for current documentation.
+Please refer to the [RCCL Documentation Site](https://rocm.docs.amd.com/projects/rccl/en/latest/) for current documentation.
 
 ### How to build documentation
 
@@ -118,7 +109,7 @@ Run the steps below to build documentation locally.
 ```
 cd docs
 
-pip3 install -r .sphinx/requirements.txt
+pip3 install -r sphinx/requirements.txt
 
 python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```

diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in
diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt
diff --git a/docs/attributions.rst b/docs/attributions.rst
@@ -40,8 +40,4 @@ under subcontract 7078610 with Lawrence Berkeley National Laboratory.
 
 This code also includes files from the NVIDIA Tools Extension SDK project.
 
-For more information and license details, see
-
- https://github.com/NVIDIA/NVTX
-
-
+For more information and license details, see [https://github.com/NVIDIA/NVTX](https://github.com/NVIDIA/NVTX)
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,10 +4,23 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import subprocess
+
 from rocm_docs import ROCmDocs
 
-docs_core = ROCmDocs("RCCL Documentation")
-docs_core.run_doxygen()
+
+name = "RCCL"
+get_major = r'sed -n -e "s/^NCCL_MAJOR.*\([0-9]\+\).*/\1/p" ../makefiles/version.mk'
+get_minor = r'sed -n -e "s/^NCCL_MINOR.*\([0-9]\{2,\}\).*/\1/p" ../makefiles/version.mk'
+get_patch = r'sed -n -e "s/^NCCL_PATCH.*\([0-9]\+\).*/\1/p" ../makefiles/version.mk'
+major = subprocess.getoutput(get_major)
+minor = subprocess.getoutput(get_minor)
+patch = subprocess.getoutput(get_patch)
+
+external_toc_path = "./sphinx/_toc.yml"
+
+docs_core = ROCmDocs(f"{name} {major}.{minor}.{patch} Documentation")
+docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/docBin/xml")
 docs_core.setup()
 
 for sphinx_var in ROCmDocs.SPHINX_VARS:

diff --git a/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile b/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile