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

Update style guidelines (#2542)

Browse Source
This commit is contained in:
Lisa
2023-10-12 13:50:15 -06:00
committed by GitHub
parent 4b7775d264
commit c6e2856822
8 changed files with 321 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -21,20 +21,20 @@ source software compilers, debuggers, and libraries. ROCm is fully integrated in
## ROCm documentation
The ROCm Documentation site is [rocm.docs.amd.com](https://rocm.docs.amd.com).
Source code for the documentation is located in the docs folder of most repositories that are part of
ROCm.
This repository contains the manifest file for ROCm releases, changelogs, and release information.
The file `default.xml` contains information for all repositories and the associated commit used to build
the current ROCm release.
The `default.xml` file uses the repo Manifest Format.
The `default.xml` file contains information for all repositories and the associated commit used to build
the current ROCm release; `default.xml` uses the Manifest Format repository.
The develop branch of this repository contains content for the next ROCm release.
Source code for our documentation is located in the `/docs` folder of most ROCm repositories. The
`develop` branch of our repositories contains content for the next ROCm release.
### How to build documentation via Sphinx
The ROCm documentation homepage is [rocm.docs.amd.com](https://rocm.docs.amd.com).
### Building our 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