Update Read the Docs, documentation, and dependabot (#772)

* update documentation

add version number to documentation

rename .sphinx/.doxygen to sphinx/doxygen

enable htmlzip, pdf, epub formats when publishing on Read the Docs

* add noCI label for dependabot PRs

since RTD CI is separate from math lib CI

* update rocm-docs-core to v0.13.4

* update README with link to rocm.docs.amd.com
此提交包含在:
Sam Wu
2023-06-07 15:31:58 -06:00
提交者 GitHub
父節點 5f1f0142ac
當前提交 c3f47853bd
共有 12 個檔案被更改,包括 55 行新增33 行删除
+4 -13
查看文件
@@ -32,6 +32,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
@@ -60,18 +61,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
@@ -108,7 +99,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
@@ -117,7 +108,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
```