github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-01-08 22:28:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

edited the contributing section (#3981)

Browse Source 
* removed the building doc; edited toolchain to remove myst; made the fact that rst is the preferred format evident

* edited the readme so that it points to the contributing to the rocm docs page

* Update docs/contribute/contributing.md

Co-authored-by: Peter Park <peter.park@amd.com>

* Update docs/contribute/contributing.md

Co-authored-by: Peter Park <peter.park@amd.com>

* added two images showing where the checks and doc build is

---------

Co-authored-by: Peter Park <peter.park@amd.com>
This commit is contained in:
spolifroni-amd
2024-11-18 14:15:01 -05:00
committed by GitHub
parent 89a978aef5
commit ae5bf79b77
4 changed files with 9 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -178,23 +178,7 @@ Source code for our documentation is located in the `/docs` folder of most ROCm
The ROCm documentation homepage is [rocm.docs.amd.com](https://rocm.docs.amd.com).
### Building the documentation
For a quick-start build, use the following code. For more options and detail, refer to
[Building documentation](./docs/contribute/building.md).
```bash
cd docs
pip3 install -r sphinx/requirements.txt
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```
Alternatively, CMake build is supported.
```bash
cmake -B build
cmake --build build --target=doc
```
For information on how to contribute to the ROCm documentation, see [Contributing to the ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
## Older ROCm releases