Browse Source

FindCUDAToolkit: Simplify internal documentation links

Brad King 5 months ago
parent
commit
d8e9b1bbdf
2 changed files with 29 additions and 71 deletions
  1. 2 2
      Help/release/3.25.rst
  2. 27 69
      Modules/FindCUDAToolkit.cmake

+ 2 - 2
Help/release/3.25.rst

@@ -163,8 +163,8 @@ Modules
   :command:`FetchContent_MakeAvailable`.
 
 * The :module:`FindCUDAToolkit` module now provides a target for
-  :ref:`nvtx3 <cuda_toolkit_nvtx3>` for CUDA 10.0+, which supersedes
-  :ref:`nvToolsExt <cuda_toolkit_nvToolsExt>`. A deprecation warning
+  :ref:`nvtx3 <FindCUDAToolkit_nvtx3>` for CUDA 10.0+, which supersedes
+  :ref:`nvToolsExt <FindCUDAToolkit_nvToolsExt>`. A deprecation warning
   is emitted when using ``nvToolsExt`` if the project requires CMake
   3.25 and CUDA 10.0+ is used.
 

+ 27 - 69
Modules/FindCUDAToolkit.cmake

@@ -110,31 +110,29 @@ An :ref:`imported target <Imported targets>` named ``CUDA::toolkit`` is provided
 This module defines :prop_tgt:`IMPORTED` targets for each
 of the following libraries that are part of the CUDAToolkit:
 
-- :ref:`CUDA Runtime Library<cuda_toolkit_rt_lib>`
-- :ref:`CUDA Driver Library<cuda_toolkit_driver_lib>`
-- :ref:`cuBLAS<cuda_toolkit_cuBLAS>`
-- :ref:`cuDLA<cuda_toolkit_cuDLA>`
-- :ref:`cuFile<cuda_toolkit_cuFile>`
-- :ref:`cuFFT<cuda_toolkit_cuFFT>`
-- :ref:`cuRAND<cuda_toolkit_cuRAND>`
-- :ref:`cuSOLVER<cuda_toolkit_cuSOLVER>`
-- :ref:`cuSPARSE<cuda_toolkit_cuSPARSE>`
-- :ref:`cuPTI<cuda_toolkit_cupti>`
-- :ref:`NPP<cuda_toolkit_NPP>`
-- :ref:`nvBLAS<cuda_toolkit_nvBLAS>`
-- :ref:`nvGRAPH<cuda_toolkit_nvGRAPH>`
-- :ref:`nvJPEG<cuda_toolkit_nvJPEG>`
-- :ref:`nvidia-ML<cuda_toolkit_nvML>`
-- :ref:`nvPTX Compiler<cuda_toolkit_nvptx>`
-- :ref:`nvRTC<cuda_toolkit_nvRTC>`
-- :ref:`nvJitLink<cuda_toolkit_nvJitLink>`
-- :ref:`nvFatBin<cuda_toolkit_nvfatbin>`
-- :ref:`nvToolsExt<cuda_toolkit_nvToolsExt>`
-- :ref:`nvtx3<cuda_toolkit_nvtx3>`
-- :ref:`OpenCL<cuda_toolkit_opencl>`
-- :ref:`cuLIBOS<cuda_toolkit_cuLIBOS>`
-
-.. _`cuda_toolkit_rt_lib`:
+- `CUDA Runtime Library`_
+- `CUDA Driver Library`_
+- `cuBLAS`_
+- `cuDLA`_
+- `cuFile`_
+- `cuFFT`_
+- `cuRAND`_
+- `cuSOLVER`_
+- `cuSPARSE`_
+- `cuPTI`_
+- `NPP`_
+- `nvBLAS`_
+- `nvGRAPH`_
+- `nvJPEG`_
+- `nvidia-ML`_
+- `nvPTX Compiler`_
+- `nvRTC`_
+- `nvJitLink`_
+- `nvFatBin`_
+- `nvToolsExt`_
+- `nvtx3`_
+- `OpenCL`_
+- `cuLIBOS`_
 
 CUDA Runtime Library
 """"""""""""""""""""
@@ -147,8 +145,6 @@ Targets Created:
 - ``CUDA::cudart``
 - ``CUDA::cudart_static``
 
-.. _`cuda_toolkit_driver_lib`:
-
 CUDA Driver Library
 """"""""""""""""""""
 
@@ -159,8 +155,6 @@ Targets Created:
 
 - ``CUDA::cuda_driver``
 
-.. _`cuda_toolkit_cuBLAS`:
-
 cuBLAS
 """"""
 
@@ -175,8 +169,6 @@ Targets Created:
 
 .. _`CUDA Basic Linear Algebra Subroutine`: https://docs.nvidia.com/cuda/cublas
 
-.. _`cuda_toolkit_cuDLA`:
-
 cuDLA
 """"""
 
@@ -190,8 +182,6 @@ Targets Created:
 
 .. _`NVIDIA Tegra Deep Learning Accelerator`: https://docs.nvidia.com/cuda/cuda-for-tegra-appnote#cudla
 
-.. _`cuda_toolkit_cuFile`:
-
 cuFile
 """"""
 
@@ -208,8 +198,6 @@ Targets Created:
 
 .. _`NVIDIA GPUDirect Storage cuFile`: https://docs.nvidia.com/gpudirect-storage/api-reference-guide
 
-.. _`cuda_toolkit_cuFFT`:
-
 cuFFT
 """""
 
@@ -225,8 +213,6 @@ Targets Created:
 
 .. _`CUDA Fast Fourier Transform`: https://docs.nvidia.com/cuda/cufft
 
-.. _`cuda_toolkit_cuRAND`:
-
 cuRAND
 """"""
 
@@ -239,8 +225,6 @@ Targets Created:
 
 .. _`CUDA random number generation`: https://docs.nvidia.com/cuda/curand
 
-.. _`cuda_toolkit_cuSOLVER`:
-
 cuSOLVER
 """"""""
 
@@ -253,8 +237,6 @@ Targets Created:
 
 .. _`GPU accelerated linear system solver`: https://docs.nvidia.com/cuda/cusolver
 
-.. _`cuda_toolkit_cuSPARSE`:
-
 cuSPARSE
 """"""""
 
@@ -267,8 +249,6 @@ Targets Created:
 
 .. _`CUDA sparse matrix`: https://docs.nvidia.com/cuda/cusparse
 
-.. _`cuda_toolkit_cupti`:
-
 cupti
 """""
 
@@ -288,8 +268,6 @@ Targets Created:
 
 .. _`NVIDIA CUDA Profiling Tools Interface`: https://developer.nvidia.com/cupti
 
-.. _`cuda_toolkit_NPP`:
-
 NPP
 """
 
@@ -313,7 +291,7 @@ Targets Created:
   - ``CUDA::nppicc_static``
 
 - `nppicom`: JPEG compression and decompression functions in `nppi_compression_functions.h`
-  Removed starting in CUDA 11.0, use :ref:`nvJPEG<cuda_toolkit_nvJPEG>` instead.
+  Removed starting in CUDA 11.0, use `nvJPEG`_ instead.
 
   - ``CUDA::nppicom``
   - ``CUDA::nppicom_static``
@@ -360,8 +338,6 @@ Targets Created:
 
 .. _`NVIDIA 2D Image and Signal Processing Performance Primitives`: https://docs.nvidia.com/cuda/npp
 
-.. _`cuda_toolkit_nvBLAS`:
-
 nvBLAS
 """"""
 
@@ -374,8 +350,6 @@ Targets Created:
 
 .. _`GPU-accelerated drop-in BLAS`: https://docs.nvidia.com/cuda/nvblas
 
-.. _`cuda_toolkit_nvGRAPH`:
-
 nvGRAPH
 """""""
 
@@ -389,8 +363,6 @@ Targets Created:
 
 .. _`GPU-accelerated graph analytics`: https://docs.nvidia.com/cuda/archive/10.0/nvgraph
 
-.. _`cuda_toolkit_nvJPEG`:
-
 nvJPEG
 """"""
 
@@ -404,8 +376,6 @@ Targets Created:
 
 .. _`GPU-accelerated JPEG codec`: https://docs.nvidia.com/cuda/nvjpeg
 
-.. _`cuda_toolkit_nvPTX`:
-
 nvPTX Compiler
 """"""""""""""
 
@@ -422,8 +392,6 @@ Targets Created:
 
 .. _`PTX Compiler APIs`: https://docs.nvidia.com/cuda/ptx-compiler-api
 
-.. _`cuda_toolkit_nvRTC`:
-
 nvRTC
 """""
 
@@ -441,8 +409,6 @@ Targets Created:
 
 .. _`runtime compilation library for CUDA`: https://docs.nvidia.com/cuda/nvrtc
 
-.. _`cuda_toolkit_nvjitlink`:
-
 nvJitLink
 """""""""
 
@@ -455,8 +421,6 @@ Targets Created:
 
 .. _`JIT Link APIs`: https://docs.nvidia.com/cuda/nvjitlink
 
-.. _`cuda_toolkit_nvfatbin`:
-
 nvFatBin
 """""""""
 
@@ -471,8 +435,6 @@ Targets Created:
 
 .. _`Fatbin Creator APIs`: https://docs.nvidia.com/cuda/nvfatbin
 
-.. _`cuda_toolkit_nvml`:
-
 nvidia-ML
 """""""""
 
@@ -488,14 +450,14 @@ Targets Created:
 
 .. _`NVIDIA Management Library`: https://developer.nvidia.com/management-library-nvml
 
-.. _`cuda_toolkit_nvToolsExt`:
+.. _`FindCUDAToolkit_nvToolsExt`:
 
 nvToolsExt
 """"""""""
 
 .. deprecated:: 3.25
 
-  With CUDA 10.0+, use :ref:`nvtx3 <cuda_toolkit_nvtx3>`.
+  With CUDA 10.0+, use `nvtx3`_.
 
 The `legacy NVIDIA Tools Extension`_.
 This is a shared library only.
@@ -506,7 +468,7 @@ Targets Created:
 
 .. _`legacy NVIDIA Tools Extension`: https://docs.nvidia.com/cuda/archive/9.0/profiler-users-guide#nvtx
 
-.. _`cuda_toolkit_nvtx3`:
+.. _`FindCUDAToolkit_nvtx3`:
 
 nvtx3
 """""
@@ -522,8 +484,6 @@ Targets created:
 
 .. _`NVIDIA Tools Extension`: https://nvidia.github.io/NVTX/doxygen
 
-.. _`cuda_toolkit_opencl`:
-
 OpenCL
 """"""
 
@@ -536,8 +496,6 @@ Targets Created:
 
 .. _`NVIDIA Open Computing Language`: https://developer.nvidia.com/opencl
 
-.. _`cuda_toolkit_cuLIBOS`:
-
 cuLIBOS
 """""""