Update docs 2025 04 14 (#54)

* Update docs 2025 03 31

- Docs: remove virtual_rocr.rst
- Fix documentation  warnings
- Reformat HIP RTC
- Docs: Refactor HIP porting guide
- Docs: Expand HIP porting guide and CUDA driver porting guide
- Minor fix
- Docs: Update environment variables file
- Bump rocm-docs-core[api_reference] from 1.15.0 to 1.17.0 in /docs/sphinx
- Docs: Update FP8 page to show both FP8 and FP16 types
- Bump sphinxcontrib-doxylink from 1.12.4 to 1.13.0 in /docs/sphinx
- Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.17.0 to 1.17.1.
- Remove external link
- Update programming model
- Bump rocm-docs-core[api_reference] from 1.17.1 to 1.18.1 in /docs/sphinx
- Docs: Add page for Complex Math API
- Docs: Add page about HIP error codes
- Update docs: the compilation cache is enabled by default
- Fix fns32 function mask type in doc

* Bump rocm-docs-core[api_reference] from 1.18.1 to 1.18.2 in /docs/sphinx

Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.18.1 to 1.18.2.
- [Release notes](https://github.com/ROCm/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.18.1...v1.18.2)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-version: 1.18.2
  dependency-type: direct:production
  update-type: version-update:semver-patch

* Fix readme link

* Docs: Fix verbose paths generated by doxygen

* Handle git ssh in docs conf.py

docs/how-to/hip_runtime_api/asynchronous.rst

@@ -136,7 +136,7 @@ This overlap of computation and data transfer ensures that the GPU is not idle
 while waiting for data. :cpp:func:`hipMemcpyPeerAsync` enables data transfers
 between different GPUs, facilitating multi-GPU communication.
 
-:ref:`async_example`` include launching kernels in one stream while performing
+:ref:`async_example` include launching kernels in one stream while performing
 data transfers in another. This technique is especially useful in applications
 with large data sets that need to be processed quickly.
 

docs/how-to/hip_runtime_api/cooperative_groups.rst

@@ -164,7 +164,7 @@ The ``thread_rank()`` , ``size()``, ``cg_type()``, ``is_valid()``, ``sync()``, `
 Coalesced groups
 ------------------
 
-Threads (64 threads on CDNA and 32 threads on RDNA) in a warp cannot execute different instructions simultaneously, so conditional branches are executed serially within the warp. When threads encounter a conditional branch, they can diverge, resulting in some threads being disabled, if they do not meet the condition to execute that branch. The active threads referred as coalesced, and coalesced group represents an active thread group within a warp.
+Threads (64 threads on CDNA and 32 threads on RDNA) in a warp cannot execute different instructions simultaneously, so conditional branches are executed serially within the warp. When threads encounter a conditional branch, they can diverge, resulting in some threads being disabled if they do not meet the condition to execute that branch. The active threads are referred to as coalesced, and coalesced group represents an active thread group within a warp.
 
 .. note::
 

docs/how-to/hip_runtime_api/error_handling.rst

@@ -37,6 +37,8 @@ Best practices of HIP error handling:
 For more details on the error handling functions, see :ref:`error handling
 functions reference page <error_handling_reference>`.
 
+For a list of all error codes, see :ref:`HIP error codes <hip_error_codes>`.
+
 .. _hip_check_macros:
 
 HIP check macros

docs/how-to/hip_runtime_api/memory_management/device_memory.rst

@@ -69,34 +69,34 @@ better option, but is also limited in size.
 .. code-block:: cpp
 
   __global__ void kernel_memory_allocation(TYPE* pointer){
-  // The pointer is stored in shared memory, so that all
-  // threads of the block can access the pointer
-  __shared__ int *memory;
+    // The pointer is stored in shared memory, so that all
+    // threads of the block can access the pointer
+    __shared__ int *memory;
 
-  size_t blockSize = blockDim.x;
-  constexpr size_t elementsPerThread = 1024;
-  if(threadIdx.x == 0){
-    // allocate memory in one contiguous block
-    memory = new int[blockDim.x * elementsPerThread];
+    size_t blockSize = blockDim.x;
+    constexpr size_t elementsPerThread = 1024;
+    if(threadIdx.x == 0){
+      // allocate memory in one contiguous block
+      memory = new int[blockDim.x * elementsPerThread];
+    }
+    __syncthreads();
+
+    // load pointer into thread-local variable to avoid
+    // unnecessary accesses to shared memory
+    int *localPtr = memory;
+
+    // work with allocated memory, e.g. initialization
+    for(int i = 0; i < elementsPerThread; ++i){
+      // access in a contiguous way
+      localPtr[i * blockSize + threadIdx.x] = i;
+    }
+
+    // synchronize to make sure no thread is accessing the memory before freeing
+    __syncthreads();
+    if(threadIdx.x == 0){
+      delete[] memory;
+    }
   }
-  __syncthreads();
-
-  // load pointer into thread-local variable to avoid
-  // unnecessary accesses to shared memory
-  int *localPtr = memory;
-
-  // work with allocated memory, e.g. initialization
-  for(int i = 0; i < elementsPerThread; ++i){
-    // access in a contiguous way
-    localPtr[i * blockSize + threadIdx.x] = i;
-  }
-
-  // synchronize to make sure no thread is accessing the memory before freeing
-  __syncthreads();
-  if(threadIdx.x == 0){
-    delete[] memory;
-  }
-}
 
 Copying between device and host
 --------------------------------------------------------------------------------

docs/how-to/hip_runtime_api/memory_management/virtual_memory.rst

@@ -25,6 +25,10 @@ issue of reallocation when the extra buffer runs out.
 Virtual memory management solves these memory management problems. It helps to
 reduce memory usage and unnecessary ``memcpy`` calls.
 
+HIP virtual memory management is built on top of HSA, which provides low-level
+access to AMD GPU memory. For more details on the underlying HSA runtime,
+see :doc:`ROCr documentation <rocr-runtime:index>`
+
 .. _memory_allocation_virtual_memory:
 
 Memory allocation