Skip to content

Commit 692f301

Browse files
mdboomclaude
mdboom
and
claude
authored
docs: Fix footnotes on the cuda.bindings install page (#3388)
Replace Markdown-style footnotes with reST footnotes, and list Windows arm64 as a supported platform. Closes #3384 Co-authored-by: Claude Sonnet 5.5 <[email protected]>
1 parent 3eb349b commit 692f301

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

‎cuda_bindings_13/docs/source/install.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Runtime Requirements
99

1010
``cuda.bindings`` supports the same platforms as CUDA. Runtime dependencies are:
1111

12-
* Linux (x86-64, arm64) and Windows (x86-64)
12+
* Linux (x86-64, arm64) and Windows (x86-64, arm64)
1313
* Python 3.11 - 3.15
1414
* Driver: Linux (580.65.06 or later) Windows (580.88 or later)
1515
* Optionally, NVRTC, nvJitLink, nvFatBin, NVVM, cuFile, and cuDLA from CUDA Toolkit 13.x
@@ -124,20 +124,20 @@ updates for development.
124124
Requirements
125125
^^^^^^^^^^^^
126126

127-
* CUDA Toolkit headers[^1]
128-
* CUDA Runtime static library[^2]
129-
* A git clone of the repository that includes tags[^3]
127+
* CUDA Toolkit headers [#]_
128+
* CUDA Runtime static library [#]_
129+
* A git clone of the repository that includes tags [#]_
130130

131-
[^1]: User projects that ``cimport`` CUDA symbols in Cython must also use CUDA Toolkit (CTK) types as provided by the ``cuda.bindings`` major.minor version. This results in CTK headers becoming a transitive dependency of downstream projects through CUDA Python.
131+
.. [#] User projects that ``cimport`` CUDA symbols in Cython must also use CUDA Toolkit (CTK) types as provided by the ``cuda.bindings`` major.minor version. This results in CTK headers becoming a transitive dependency of downstream projects through CUDA Python.
132132
133-
[^2]: The CUDA Runtime static library (``libcudart_static.a`` on Linux, ``cudart_static.lib`` on Windows) is part of the CUDA Toolkit. If using conda packages, it is contained in the ``cuda-cudart-static`` package.
133+
.. [#] The CUDA Runtime static library (``libcudart_static.a`` on Linux, ``cudart_static.lib`` on Windows) is part of the CUDA Toolkit. If using conda packages, it is contained in the ``cuda-cudart-static`` package.
134134
135-
[^3]: The version is derived from git tags via ``setuptools-scm``, so the clone
136-
must include tags reaching back to at least the latest ``v*`` tag. Do not use
137-
``--depth`` or ``--no-tags``: a clone without reachable tags can build with a
138-
bogus version such as ``0.1.dev1+g0d22cb444``. See `Cloning the repository
139-
<https://github.com/NVIDIA/cuda-python/blob/main/CONTRIBUTING.md#cloning-the-repository>`_
140-
for details.
135+
.. [#] The version is derived from git tags via ``setuptools-scm``, so the clone
136+
must include tags reaching back to at least the latest ``v*`` tag. Do not use
137+
``--depth`` or ``--no-tags``: a clone without reachable tags can build with a
138+
bogus version such as ``0.1.dev1+g0d22cb444``. See `Cloning the repository
139+
<https://github.com/NVIDIA/cuda-python/blob/main/CONTRIBUTING.md#cloning-the-repository>`_
140+
for details.
141141
142142
Source builds require that the provided CUDA headers are of the same major.minor version as the ``cuda.bindings`` you're trying to build. Despite this requirement, note that the minor version compatibility is still maintained. The build checks the header before it compiles anything. A mismatch stops the build with a message that names the ``cuda.h`` it found and the version this source tree needs. Use the ``CUDA_PATH`` (or ``CUDA_HOME``) environment variable to specify the location of your headers. If both are set, ``CUDA_PATH`` takes precedence. For example, if your headers are located in ``/usr/local/cuda/include``, then you should set ``CUDA_PATH`` with:
143143

0 commit comments

Comments
 (0)