Welcome to the documentation site for AMD Instinct Data Center GPUs. Targeted for system administrators and power users, this site provides comprehensive technical documentation, guides, and best practices for deploying and managing AMD Instinct Data Center GPUs. Content for GPU software development and applications including AI are located at ROCm documentation.
AMD GPU Systems and Infrastructure documentation
This guide provides information for developers who want to contribute to the AMD GPU Systems and Infrastructure documentation site. The documentation uses rocm-docs-core as the base. The following guide shows how you can build and access the documentation locally for testing.
- Create a Python Virtual Environment (optional, but recommended).
python3 -m venv .venv/docs- Activate the Virtual Environment.
source .venv/docs/bin/activate # For Linux
source .venv/docs/Scripts/activate # For Windows- Install the required packages for the documentation.
pip install -r docs/sphinx/requirements.txt- Build the documentation.
python3 -m sphinx -b html -d _build/doctrees -D language=en ./docs/ docs/_build/html- Serve the documentation locally on port 8000.
python3 -m http.server -d ./docs/_build/html/- You can now view the documentation site by going to http://localhost:8000.
The following instructions allow you to watch the docs directory and rebuild the documentation each time you make a change to the documentation files:
- Install Sphinx Autobuild package
pip install sphinx-autobuild- Run the autobuild (will also serve the documentation on port 8000 automatically).
sphinx-autobuild -b html -d _build/doctrees -D language=en ./docs docs/_build/html --ignore "docs/_build/*" --ignore "docs/sphinx/_toc.yml" --ignore "docs/sphinx/requirements.txt"Note that if you've recently added a new link to the navigation menu, previously unchanged pages may not correctly display the new link. To fix this, delete the existing _build/ directory and rebuild the documentation so that the navigation menu will be rebuilt for all pages.