Links for Reference pages (#2307)

* reorg toc to match all ref material page * add links to docs, github, and changelogs
2026-01-10 07:08:08 -05:00 · 2023-06-29 16:55:48 -06:00
parent c71d83207e
commit 12bc633320
13 changed files with 91 additions and 50 deletions
--- a/docs/reference/ai_tools.md
+++ b/docs/reference/ai_tools.md
@@ -7,6 +7,8 @@
 AMD's library for high performance machine learning primitives.

 - {doc}`Documentation <miopen:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/MIOpen)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/develop/CHANGELOG.md)

 :::

@@ -14,13 +16,17 @@ AMD's library for high performance machine learning primitives.
 Composable Kernel: Performance Portable Programming Model for Machine Learning Tensor Operators

 - {doc}`Documentation <composable_kernel:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/composable_kernel)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/composable_kernel/blob/develop/CHANGELOG.md)

 :::

-:::{grid-item-card} {doc}`MIGraphX <migraphx:index>`
+:::{grid-item-card} {doc}`MIGraphX <amdmigraphx:index>`
 AMD MIGraphX is AMD's graph inference engine that accelerates machine learning model inference.

- {doc}`Documentation <migraphx:index>`
+- {doc}`Documentation <amdmigraphx:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX)
+- [Changelog](https://github.com/ROCmSoftwarePlatform/AMDMIGraphX/blob/develop/CHANGELOG.md)

 :::

--- a/docs/reference/all.md
+++ b/docs/reference/all.md
@@ -8,8 +8,9 @@
 :::{grid-item-card} [HIP](./hip)
 HIP is both AMD's GPU programming language extension and the GPU runtime.

- {doc}`hip:.doxygen/docBin/html/index`
- [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)
+- {doc}`HIP <hip:index>`
+- [HIP Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)
+- {doc}`HIPIFY <hipify:index>`

 :::

@@ -43,7 +44,7 @@ Libraries related to AI.

 - {doc}`MIOpen <miopen:index>`
 - {doc}`Composable Kernel <composable_kernel:index>`
- {doc}`MIGraphX <migraphx:index>`
+- {doc}`MIGraphX <amdmigraphx:index>`

 :::

@@ -64,6 +65,7 @@ Computer vision related projects.
 :::{grid-item-card} [Compilers and Tools](compilers)

 - [ROCmCC](/reference/rocmcc/rocmcc)
+- {doc}`ROCdbgapi <rocdbgapi:index>`
 - {doc}`ROCgdb <rocgdb:index>`
 - {doc}`ROCProfiler <rocprofiler:rocprof>`
 - {doc}`ROCTracer <roctracer:index>`
@@ -72,9 +74,9 @@ Computer vision related projects.

 :::{grid-item-card} [Management Tools](management_tools)

- AMD SMI
- ROCm SMI
- ROCm Data Center Tool
+- {doc}`AMD SMI <amdsmi:index>`
+- {doc}`ROCm SMI <rocm_smi_lib:index>`
+- {doc}`ROCm Data Center Tool <rdc:index>`

 :::

--- a/docs/reference/compilers.md
+++ b/docs/reference/compilers.md
@@ -3,42 +3,46 @@
 :::::{grid} 1 1 2 2
 :gutter: 1

-:::{grid-item-card} ROCmCC
-:link: /reference/rocmcc/rocmcc
-:link-type: doc
+:::{grid-item-card} {doc}`ROCdbgapi <rocdbgapi:index>`
+The AMD Debugger API is a library that provides all the support necessary for a
+debugger and other tools to perform low level control of the execution and
+inspection of execution state of AMD's commercially available GPU architectures.
+
+- {doc}`Documentation <rocdbgapi:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/ROCdbgapi/)
+
+:::
+
+:::{grid-item-card} [ROCmCC](./rocmcc/rocmcc)
 ROCmCC is a Clang/LLVM-based compiler. It is optimized for high-performance
 computing on AMD GPUs and CPUs and supports various heterogeneous programming
 models such as HIP, OpenMP, and OpenCL.

+- [Documentation](./rocmcc/rocmcc)
+
 :::

-:::{grid-item-card} ROCgdb
-:link: rocgdb:index
-:link-type: doc
+:::{grid-item-card} {doc}`ROCgdb <rocgdb:index>`
 This is ROCgdb, the ROCm source-level debugger for Linux, based on GDB, the GNU source-level debugger.

+- {doc}`Documentation <rocgdb:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/ROCgdb/)
+
 :::

-:::{grid-item-card} ROCProfiler
-:link: rocprofiler:rocprof
-:link-type: doc
+:::{grid-item-card} {doc}`ROCProfiler <rocprofiler:rocprof>`
 ROC profiler library. Profiling with performance counters and derived metrics. Library supports GFX8/GFX9. Hardware specific low-level performance analysis interface for profiling of GPU compute applications. The profiling includes hardware performance counters with complex performance metrics.

-:::
-
-:::{grid-item-card} ROCTracer
-:link: roctracer:index
-:link-type: doc
-Callback/Activity Library for Performance tracing AMD GPU's
+- {doc}`Documentation <rocprofiler:rocprof>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/rocprofiler/)

 :::

-:::{grid-item-card} ROCdbgapi
-:link: rocdbgapi:index
-:link-type: doc
-The AMD Debugger API is a library that provides all the support necessary for a
-debugger and other tools to perform low level control of the execution and
-inspection of execution state of AMD's commercially available GPU architectures.
+:::{grid-item-card} {doc}`ROCTracer <roctracer:index>`
+Callback/Activity Library for Performance tracing AMD GPUs
+
+- {doc}`Documentation <roctracer:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/roctracer)

 :::

--- a/docs/reference/computer_vision.md
+++ b/docs/reference/computer_vision.md
@@ -7,6 +7,8 @@
 MIVisionX toolkit is a set of comprehensive computer vision and machine intelligence libraries, utilities, and applications bundled into a single toolkit. AMD MIVisionX also delivers a highly optimized open-source implementation of the Khronos OpenVX™ and OpenVX™ Extensions.

 - {doc}`Documentation <mivisionx:README>`
+- [GitHub](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/)
+- [Changelog](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX/blob/master/CHANGELOG.md)

 :::

--- a/docs/reference/gpu_libraries/c++_primitives.md
+++ b/docs/reference/gpu_libraries/c++_primitives.md
@@ -11,6 +11,7 @@ transforms, reductions, scans, etc. It also serves as a common back-end for
 similar libraries found inside ROCm.

 - {doc}`Documentation <rocprim:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocPRIM/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocPRIM/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocPRIM)

@@ -22,6 +23,7 @@ interface. Their CPU back-ends are identical, while the GPU back-end calls into
 rocPRIM.

 - {doc}`Documentation <rocthrust:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocThrust)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocThrust/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocThrust)

@@ -32,6 +34,7 @@ hipCUB is a template library of algorithm primitives with a CUB-compatible
 interface. It's back-end is rocPRIM.

 - {doc}`Documentation <hipcub:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipCUB)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipCUB/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/hipCUB)

--- a/docs/reference/gpu_libraries/communication.md
+++ b/docs/reference/gpu_libraries/communication.md
@@ -10,6 +10,7 @@ The collective operations are implemented using ring and tree algorithms and hav
 throughput and latency.

 - {doc}`Documentation <rccl:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rccl)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/ROCmSoftwarePlatform/rccl/tree/develop/tools)

--- a/docs/reference/gpu_libraries/fft.md
+++ b/docs/reference/gpu_libraries/fft.md
@@ -9,6 +9,7 @@ ROCm libraries for FFT are as follows:
 rocFFT is an AMD GPU optimized library for FFT.

 - {doc}`Documentation <rocfft:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocFFT)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)

 :::
@@ -19,6 +20,7 @@ using rocFFT. hipFFT allows for a common interface for other non AMD GPU
 FFT libraries.

 - {doc}`Documentation <hipfft:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipFFT)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/CHANGELOG.md)

 :::
--- a/docs/reference/gpu_libraries/linear_algebra.md
+++ b/docs/reference/gpu_libraries/linear_algebra.md
@@ -9,6 +9,7 @@ ROCm libraries for linear algebra are as follows:
 `rocBLAS` is an AMD GPU optimized library for BLAS (Basic Linear Algebra Subprograms).

 - {doc}`Documentation <rocblas:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocBLAS)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS)

@@ -20,6 +21,7 @@ via `rocBLAS` and `rocSOLVER`. `hipBLAS` allows for a common interface for other
 BLAS libraries.

 - {doc}`Documentation <hipblas:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipBLAS)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/CHANGELOG.md)

 :::
@@ -31,6 +33,7 @@ flexible API and extends functionalities beyond traditional BLAS library.
 optimized generator as a back-end kernel provider.

 - {doc}`Documentation <hipblaslt:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipBLASLt)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLASLt/blob/develop/CHANGELOG.md)

 :::
@@ -41,6 +44,7 @@ fine-grained parallelism on top of AMD's ROCm runtime and toolchains, targeting
 modern CPU and GPU platforms.

 - {doc}`Documentation <rocalution:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocALUTION)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md)

 :::
@@ -50,6 +54,7 @@ modern CPU and GPU platforms.
 (MMA) problems into fragments and distributes these over GPU wavefronts.

 - {doc}`Documentation <rocwmma:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocWMMA)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/CHANGELOG.md)

 :::
@@ -58,6 +63,7 @@ modern CPU and GPU platforms.
 `rocSOLVER` provides a subset of LAPACK (Linear Algebra Package) functionality on the ROCm platform.

 - {doc}`Documentation <rocsolver:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocSOLVER)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)

 :::
@@ -67,6 +73,7 @@ modern CPU and GPU platforms.
 as backends whilst exporting a unified interface.

 - {doc}`Documentation <hipsolver:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipSOLVER)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)

 :::
@@ -75,6 +82,7 @@ as backends whilst exporting a unified interface.
 `rocSPARSE` is a library to provide BLAS for sparse computations.

 - {doc}`Documentation <rocsparse:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocSPARSE)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md)

 :::
@@ -84,6 +92,7 @@ as backends whilst exporting a unified interface.
 supporting both `rocSPARSE` and `cuSPARSE` as backends.

 - {doc}`Documentation <hipsparse:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipSPARSE)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md)

 :::
--- a/docs/reference/gpu_libraries/rand.md
+++ b/docs/reference/gpu_libraries/rand.md
@@ -7,6 +7,7 @@
 rocRAND is an AMD GPU optimized library for pseudo-random number generators (PRNG).

 - {doc}`Documentation <rocrand:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/rocRAND/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/CHANGELOG.md)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocRAND)

@@ -18,6 +19,7 @@ generation (PRNG) optimized for AMD GPUs using rocRAND. hipRAND allows for a
 common interface for other non AMD GPU PRNG libraries.

 - {doc}`Documentation <hiprand:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/hipRAND/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/hipRAND/blob/develop/CHANGELOG.md)

 :::
--- a/docs/reference/hip.md
+++ b/docs/reference/hip.md
@@ -12,7 +12,8 @@ page introduces the HIP runtime and other HIP libraries and tools.
 The HIP Runtime is used to enable GPU acceleration for all HIP language based
 products.

- {doc}`API Reference Manual <hip:.doxygen/docBin/html/index>`
+- {doc}`Documentation <hip:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/HIP)
 - [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)

 :::
@@ -28,7 +29,9 @@ products.
 HIPIFY assists with porting applications from based on CUDA to the HIP Runtime.
 Supported CUDA APIs are documented here as well.

- {doc}`Reference Manual <hipify:index>`
+- {doc}`Documentation <hipify:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/HIPIFY/)
+- [Changelog](https://github.com/ROCm-Developer-Tools/HIPIFY/blob/amd-staging/CHANGELOG.md)

 :::

--- a/docs/reference/management_tools.md
+++ b/docs/reference/management_tools.md
@@ -3,26 +3,30 @@
 :::::{grid} 1 1 3 3
 :gutter: 1

-:::{grid-item-card} AMD SMI
+:::{grid-item-card} {doc}`AMD SMI <amdsmi:index>`
 The AMD System Management Interface Library, or AMD SMI library, is a C library for Linux that provides a user space interface for applications to monitor and control AMD devices.

+- {doc}`Documentation <amdsmi:index>`
 - [GitHub](https://github.com/RadeonOpenCompute/amdsmi)
 - [Examples](https://github.com/amd/go_amd_smi#example)

 :::

-:::{grid-item-card} ROCm SMI
+:::{grid-item-card} {doc}`ROCm SMI LIB <rocm_smi_lib:index>`
 This tool acts as a command line interface for manipulating and monitoring the AMD GPU kernel, and is intended to replace and deprecate the existing `rocm_smi.py` CLI tool. It uses `ctypes` to call the `rocm_smi_lib` API.

+- {doc}`Documentation <rocm_smi_lib:index>`
 - [GitHub](https://github.com/RadeonOpenCompute/rocm_smi_lib)
 - [Examples](https://github.com/RadeonOpenCompute/rocm_smi_lib/tree/master/python_smi_tools)

 :::

-:::{grid-item-card} ROCm Data Center Tool
+:::{grid-item-card} {doc}`ROCm Data Center Tool <rdc:index>`
 The ROCm™ Data Center Tool simplifies the administration and addresses key infrastructure challenges in AMD GPUs in cluster and data center environments.

+- {doc}`Documentation <rdc:index>`
 - [GitHub](https://github.com/RadeonOpenCompute/rdc)
+- [Changelog](https://github.com/RadeonOpenCompute/rdc/blob/master/CHANGELOG.md)
 - [Examples](https://github.com/RadeonOpenCompute/rdc/tree/master/example)

 :::
--- a/docs/reference/validation_tools.md
+++ b/docs/reference/validation_tools.md
@@ -7,6 +7,8 @@
 The ROCm Validation Suite is a system administrator’s and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform.

 - {doc}`Documentation <rocmvalidationsuite:index>`
+- [GitHub](https://github.com/ROCm-Developer-Tools/ROCmValidationSuite)
+- [Changelog](https://github.com/ROCm-Developer-Tools/ROCmValidationSuite/blob/master/CHANGELOG.md)

 :::

@@ -14,6 +16,7 @@ The ROCm Validation Suite is a system administrator’s and cluster manager's to
 TransferBench is a simple utility capable of benchmarking simultaneous transfers between user-specified devices (CPUs/GPUs).

 - {doc}`Documentation <transferbench:index>`
+- [GitHub](https://github.com/ROCmSoftwarePlatform/TransferBench/)
 - [Changelog](https://github.com/ROCmSoftwarePlatform/TransferBench/blob/develop/CHANGELOG.md)
 - {doc}`transferbench:examples/index`

--- a/docs/sphinx/_toc.yml.in
+++ b/docs/sphinx/_toc.yml.in
@@ -61,20 +61,6 @@ subtrees:
 - caption: APIs and Reference
  entries:
    - file: reference/all
-    - file: reference/compilers
-      title: Compilers and Tools
-      subtrees:
-        - entries:
-          - file: reference/rocmcc/rocmcc
-            title: ROCmCC
-          - url: ${project:rocgdb}
-            title: ROCgdb
-          - url: ${project:rocprofiler}
-            title: rocprofiler
-          - url: ${project:roctracer}
-            title: roctracer
-          - url: ${project:rocdbgapi}
-            title: ROCdbgapi
    - file: reference/hip
      subtrees:
        - entries:
@@ -82,8 +68,6 @@ subtrees:
              url: ${project:hip}
            - title: HIPify - Port Your Code
              url: ${project:hipify}
-    - file: reference/openmp/openmp
-      title: OpenMP
    - file: reference/gpu_libraries/math
      title: Math Libraries
      subtrees:
@@ -159,6 +143,22 @@ subtrees:
        - entries:
          - url: ${project:rocal}
            title: rocAL 
+    - file: reference/openmp/openmp
+      title: OpenMP
+    - file: reference/compilers
+      title: Compilers and Tools
+      subtrees:
+        - entries:
+          - file: reference/rocmcc/rocmcc
+            title: ROCmCC
+          - url: ${project:rocgdb}
+            title: ROCgdb
+          - url: ${project:rocprofiler}
+            title: rocprofiler
+          - url: ${project:roctracer}
+            title: roctracer
+          - url: ${project:rocdbgapi}
+            title: ROCdbgapi
    - file: reference/management_tools
      title: Management Tools
      subtrees: