This repository contains the source for the top-level ROCm documentation site. It builds the landing pages, installation and compatibility guides, and the navigation that ties the per-project documentation together.
It is a documentation-only repository: it holds no ROCm source code. Individual ROCm components keep their own documentation in their own repositories, which this site links out to.
The site is built with Sphinx and
rocm-docs-core. To build it locally:
cd docs/sphinx
pip install -r requirements.txt
python -m sphinx -T -b html -d _build/doctrees -D language=en ../.. _build/htmlThe rendered site is written to docs/sphinx/_build/html. Open index.html
there to preview it. See Contributing to ROCm docs
for authoring guidelines, style, and the review process.
To propose documentation changes, open a pull request against this repository. See CONTRIBUTING.md and the ROCm documentation contribution guide.
For contribution guidelines in the wider ROCm project, see:
To report a security vulnerability, see SECURITY.md. Do not report vulnerabilities through public GitHub issues.
See the LICENSE file for this repository. For ROCm-wide licensing, see the ROCm licenses page.