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](ROCm/rocm-docs-core@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

Author: neon60

.wordlist.txt

@@ -7,8 +7,11 @@ APUs
 AQL
 AXPY
 asm
+Asynchronicity
+Asynchrony
 asynchrony
 backtrace
+bfloat
 Bitcode
 bitcode
 bitcodes
@@ -24,18 +27,19 @@ coroutines
 Ctx
 cuBLASLt
 cuCtx
-CUDA's
+CUDA
+cuda
 cuDNN
 cuModule
 dataflow
 deallocate
 decompositions
 denormal
 Dereferencing
+DFT
 dll
 DirectX
 EIGEN
-EIGEN's
 enqueue
 enqueues
 entrypoint
@@ -61,7 +65,6 @@ hardcoded
 HC
 hcBLAS
 HIP-Clang
-HIP's
 hipcc
 hipCtx
 hipexamine
@@ -71,6 +74,7 @@ hipModule
 hipModuleLaunchKernel
 hipother
 HIPRTC
+hyperthreading
 icc
 IILE
 iGPU
@@ -91,7 +95,6 @@ iteratively
 Lapack
 latencies
 libc
-libhipcxx
 libstdc
 lifecycle
 linearizing
@@ -116,6 +119,7 @@ NDRange
 nonnegative
 NOP
 Numa
+ns
 Nsight
 ocp
 omnitrace
@@ -124,6 +128,7 @@ overindexing
 oversubscription
 overutilized
 parallelizable
+pipelining
 parallelized
 pixelated
 pragmas
@@ -142,7 +147,6 @@ quad
 representable
 RMW
 rocgdb
-ROCm's
 rocTX
 roundtrip
 rst
@@ -155,10 +159,10 @@ sceneries
 shaders
 SIMT
 sinewave
+sinf
 SOMA
 SPMV
 structs
-struct's
 SYCL
 syntaxes
 texel
@@ -169,8 +173,11 @@ templated
 toolkits
 transfering
 typedefs
+ULP
+ULPs
 unintuitive
 UMM
+uncoalesced
 unmap
 unmapped
 unmapping

README.md

@@ -36,33 +36,6 @@ HIP releases are typically naming convention for each ROCM release to help diffe
 * rocm x.yy: These are the stable releases based on the ROCM release.
   This type of release is typically made once a month.*
 
-## More Info
-
-* [Installation](docs/install/install.rst)
-* [HIP FAQ](docs/faq.rst)
-* [HIP C++ Language Extensions](docs/reference/cpp_language_extensions.rst)
-* [HIP Porting Guide](docs/how-to/hip_porting_guide.md)
-* [HIP Porting Driver Guide](docs/how-to/hip_porting_driver_api.rst)
-* [HIP Programming Guide](docs/programming_guide.rst)
-* [HIP Logging](docs/how-to/logging.rst)
-* [Building HIP From Source](docs/install/build.rst)
-* [HIP Debugging](docs/how-to/debugging.rst)
-* [HIP RTC](docs/how-to/hip_rtc.md)
-* [HIP Terminology](docs/reference/terms.md) (including Rosetta Stone of GPU computing terms across CUDA/HIP/OpenCL)
-* [HIPIFY](https://github.com/ROCm/HIPIFY/blob/amd-staging/README.md)
-* Supported CUDA APIs:
-  * [Runtime API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUDA_Runtime_API_functions_supported_by_HIP.md)
-  * [Driver API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUDA_Driver_API_functions_supported_by_HIP.md)
-  * [cuComplex API](https://github.com/ROCm/HIPIFY/blob/amd-staging/reference/docs/tables/cuComplex_API_supported_by_HIP.md)
-  * [Device API](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUDA_Device_API_supported_by_HIP.md)
-  * [cuBLAS](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUBLAS_API_supported_by_ROC.md)
-  * [cuRAND](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CURAND_API_supported_by_HIP.md)
-  * [cuDNN](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUDNN_API_supported_by_HIP.md)
-  * [cuFFT](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUFFT_API_supported_by_HIP.md)
-  * [cuSPARSE](https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/reference/tables/CUSPARSE_API_supported_by_HIP.md)
-* [Developer/CONTRIBUTING Info](CONTRIBUTING.md)
-* [Release Notes](RELEASE.md)
-
 ## How do I get set up?
 
 See the [Installation](docs/install/install.rst) notes.
@@ -91,7 +64,7 @@ hipMemcpy(C_h, C_d, Nbytes, hipMemcpyDeviceToHost);
 
 The HIP kernel language defines builtins for determining grid and block coordinates, math functions, short vectors,
 atomics, and timer functions.
-It also specifies additional defines and keywords for function types, address spaces, and optimization controls (See the [HIP C++ Language Extensions](docs/reference/cpp_language_extensions.rst) for a full description).
+It also specifies additional defines and keywords for function types, address spaces, and optimization controls (See the [HIP C++ Language Extensions](docs/how-to/hip_cpp_language_extensions.rst) for a full description).
 Here's an example of defining a simple 'vector_square' kernel.
 
 ```cpp

RELEASE.md

@@ -6,6 +6,7 @@
 
 import re
 import sys
+import subprocess
 from pathlib import Path
 from typing import Any, Dict, List
 
@@ -57,4 +58,8 @@
     "understand/glossary.md",
     'how-to/debugging_env.rst',
     "data/env_variables_hip.rst"
-]
+]
+
+git_url = subprocess.check_output(['git', 'config', '--get', 'remote.origin.url']).strip().decode('ascii')
+if git_url.find("git:") != -1:
+    html_theme_options = {"repository_url": "https://github.com/ROCm/hip"}