Docs: Fix broken links, warnings and use automodule (#11)

- Fixes the broken links in rocm_smi.h
- Uses automodule instead of autofunction in docs/reference/python_api.rst
- Fixes some warnings during docs build
- Update some of the versions in requirements.txt
This commit is contained in:
Johar, Adel authored and Charis Poag committed 2025-03-09 14:23:22 -05:00
1 parent a938e743f0
commit fc61e40506
8 files changed
+52 -298

No files matched your search

+7 -9
Vedi File
@@ -7,7 +7,7 @@
Installing ROCm SMI
*********************
Planned deprecation notice
Planned deprecation notice
----------------------------
ROCm System Management Interface (ROCm SMI) Library is planned to be ***deprecated***, and the release date will be announced soon. We recommend migration to AMD SMI.
@@ -15,11 +15,11 @@ ROCm System Management Interface (ROCm SMI) Library is planned to be ***deprecat
Install amdgpu using ROCm
--------------------------
Use the following instructions to install AMDGPU using ROCm:
1. Install amdgpu driver. Refer to the following example, your release and link may differ. The `amdgpu-install --usecase=rocm` triggers both an amdgpu driver update and ROCm SMI packages to be installed on your device.
.. code-block:: shell
sudo apt update
wget https://repo.radeon.com/amdgpu-install/6.0.2/ubuntu/jammy/amdgpu-install_6.0.60002-1_all.deb
sudo apt install ./amdgpu-install_6.0.60002-1_all.deb
@@ -33,10 +33,8 @@ Building ROCm SMI
Addtional required software
============================
To build the ROCm SMI library, the following components are required.
.. Note::
To build the ROCm SMI library, the following components are required.
The following software versions are what was used in development. Earlier versions are not guaranteed to work:
* CMake (v3.5.0)
@@ -52,7 +50,7 @@ The source code for ROCm SMI is available on `Github <https://github.com/RadeonO
After the ROCm SMI library git repository is cloned to a local Linux machine, use the following CMake build sequence to build the library. Specifically,
.. code-block:: shell
mkdir -p build
cd build
cmake ..