Deploy doc preview for PR 1316 (e72f8a0)

Author: cuda-python-bot

docs/pr-preview/pr-1316/cuda-core/latest/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8dc718944e33f87188ab5dbb11ff09aa
+config: ab5cb85196b616d5f6216cfd867ac2ec
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/pr-preview/pr-1316/cuda-core/latest/_sources/developer-guide.rst.txt

@@ -192,11 +192,11 @@ File Types
 
 The ``cuda/core`` package uses three types of files:
 
-1. **``.pyx`` files**: Cython implementation files containing the actual
+1. **.pyx files**: Cython implementation files containing the actual
    code
-2. **``.pxd`` files**: Cython declaration files containing type
+2. **.pxd files**: Cython declaration files containing type
    definitions and function signatures for C-level access
-3. **``.py`` files**: Pure Python files for utilities and high-level
+3. **.py files**: Pure Python files for utilities and high-level
    interfaces
 
 File Naming Conventions
@@ -217,10 +217,10 @@ Relationship Between ``.pxd`` and ``.pyx`` Files
 For each ``.pyx`` file that defines classes or functions used by other
 Cython modules, create a corresponding ``.pxd`` file:
 
-- **``.pxd`` file**: Contains ``cdef`` class declarations,
+- **.pxd file**: Contains ``cdef`` class declarations,
   ``cdef``/``cpdef`` function signatures, and ``cdef`` attribute
   declarations
-- **``.pyx`` file**: Contains the full implementation including Python
+- **.pyx file**: Contains the full implementation including Python
   methods, docstrings, and implementation details
 
 **Example:**
@@ -275,12 +275,12 @@ For complex subpackages that require extra structure (like
 
 1. **Private submodules**: Each component is implemented in a private
    submodule (e.g., ``_buffer.pyx``, ``_device_memory_resource.pyx``)
-2. **Submodule ``__all__``**: Each submodule defines its own ``__all__``
+2. **Submodule __all__**: Each submodule defines its own ``__all__``
    list
-3. **Subpackage ``__init__.py``**: The subpackage ``__init__.py`` uses
+3. **Subpackage __init__.py**: The subpackage ``__init__.py`` uses
    ``from ._module import *`` to assemble the package
 
-**Example structure for ``_memory/`` subpackage:**
+**Example structure for _memory/ subpackage:**
 
 ``_memory/_buffer.pyx``:
 
@@ -335,19 +335,19 @@ improve maintainability).
 Guidelines
 ~~~~~~~~~~
 
-1. **Always create ``.pxd`` files for shared Cython types**: If a class
+1. **Always create .pxd files for shared Cython types**: If a class
    or function is ``cimport``\ ed by other modules, provide a ``.pxd``
    declaration file.
 
-2. **Keep ``.pxd`` files minimal**: Only include declarations needed for
+2. **Keep .pxd files minimal**: Only include declarations needed for
    Cython compilation. Omit implementation details, docstrings, and
    Python-only code.
 
-3. **Use ``__all__`` when helpful**: Define ``__all__`` to control
+3. **Use __all__ when helpful**: Define ``__all__`` to control
    exported symbols when it simplifies or clarifies the module
    structure.
 
-4. **Use ``from ._module import *`` in subpackage ``__init__.py``**:
+4. **Use from ._module import * in subpackage __init__.py**:
    This pattern assembles the subpackage API from its submodules. Use
    ``# noqa: F403`` to suppress linting warnings about wildcard imports.
 
@@ -476,7 +476,7 @@ Additional Rules
    Do not use blank lines within a group unless using multi-line import
    formatting.
 
-5. **``try/except`` Blocks**: Import fallbacks (e.g., for optional
+5. **try/except blocks**: Import fallbacks (e.g., for optional
    dependencies) should be placed in the appropriate group (external or
    cuda-core) using ``try/except`` blocks.
 
@@ -756,13 +756,13 @@ header). This enables:
 Guidelines
 ^^^^^^^^^^
 
-1. **Use ``from __future__ import annotations``**: This should be
+1. **Use from __future__ import annotations**: This should be
    present in all ``.py`` and ``.pyx`` files with type annotations.
 
-2. **Use ``|`` for unions**: Prefer ``X | Y | None`` over
+2. **Use | for unions**: Prefer ``X | Y | None`` over
    ``Union[X, Y]`` or ``Optional[X]``.
 
-3. **Avoid ``TYPE_CHECKING`` blocks**: With
+3. **Avoid TYPE_CHECKING blocks**: With
    ``from __future__ import annotations``, forward references work
    without ``TYPE_CHECKING`` guards.
 
@@ -1113,8 +1113,8 @@ CUDA Exceptions
 
 The project defines custom exceptions for CUDA-specific errors:
 
-- **``CUDAError``**: Base exception for CUDA driver errors
-- **``NVRTCError``**: Exception for NVRTC compiler errors (inherits from
+- **CUDAError**: Base exception for CUDA driver errors
+- **NVRTCError**: Exception for NVRTC compiler errors (inherits from
   ``CUDAError``)
 
 Use these instead of generic exceptions when reporting CUDA failures.

docs/pr-preview/pr-1316/cuda-core/latest/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.5.1.dev38',
+    VERSION: '0.5.1.dev39',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/pr-preview/pr-1316/cuda-core/latest/api.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="_static/documentation_options.js?v=49139664"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>

docs/pr-preview/pr-1316/cuda-core/latest/api_private.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="_static/documentation_options.js?v=49139664"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>

docs/pr-preview/pr-1316/cuda-core/latest/conduct.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="_static/documentation_options.js?v=49139664"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>

docs/pr-preview/pr-1316/cuda-core/latest/contribute.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="_static/documentation_options.js?v=49139664"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>

docs/pr-preview/pr-1316/cuda-core/latest/developer-guide.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="_static/documentation_options.js?v=49139664"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>
@@ -745,11 +745,11 @@ <h2>Package Layout<a class="headerlink" href="#package-layout" title="Link to th
 <h3>File Types<a class="headerlink" href="#file-types" title="Link to this heading">#</a></h3>
 <p>The <code class="docutils literal notranslate"><span class="pre">cuda/core</span></code> package uses three types of files:</p>
 <ol class="arabic simple">
-<li><p><strong>``.pyx`` files</strong>: Cython implementation files containing the actual
+<li><p><strong>.pyx files</strong>: Cython implementation files containing the actual
 code</p></li>
-<li><p><strong>``.pxd`` files</strong>: Cython declaration files containing type
+<li><p><strong>.pxd files</strong>: Cython declaration files containing type
 definitions and function signatures for C-level access</p></li>
-<li><p><strong>``.py`` files</strong>: Pure Python files for utilities and high-level
+<li><p><strong>.py files</strong>: Pure Python files for utilities and high-level
 interfaces</p></li>
 </ol>
 </section>
@@ -769,10 +769,10 @@ <h3>File Naming Conventions<a class="headerlink" href="#file-naming-conventions"
 <p>For each <code class="docutils literal notranslate"><span class="pre">.pyx</span></code> file that defines classes or functions used by other
 Cython modules, create a corresponding <code class="docutils literal notranslate"><span class="pre">.pxd</span></code> file:</p>
 <ul class="simple">
-<li><p><strong>``.pxd`` file</strong>: Contains <code class="docutils literal notranslate"><span class="pre">cdef</span></code> class declarations,
+<li><p><strong>.pxd file</strong>: Contains <code class="docutils literal notranslate"><span class="pre">cdef</span></code> class declarations,
 <code class="docutils literal notranslate"><span class="pre">cdef</span></code>/<code class="docutils literal notranslate"><span class="pre">cpdef</span></code> function signatures, and <code class="docutils literal notranslate"><span class="pre">cdef</span></code> attribute
 declarations</p></li>
-<li><p><strong>``.pyx`` file</strong>: Contains the full implementation including Python
+<li><p><strong>.pyx file</strong>: Contains the full implementation including Python
 methods, docstrings, and implementation details</p></li>
 </ul>
 <p><strong>Example:</strong></p>
@@ -819,12 +819,12 @@ <h4>Complex Subpackages<a class="headerlink" href="#complex-subpackages" title="
 <ol class="arabic simple">
 <li><p><strong>Private submodules</strong>: Each component is implemented in a private
 submodule (e.g., <code class="docutils literal notranslate"><span class="pre">_buffer.pyx</span></code>, <code class="docutils literal notranslate"><span class="pre">_device_memory_resource.pyx</span></code>)</p></li>
-<li><p><strong>Submodule ``__all__``</strong>: Each submodule defines its own <code class="docutils literal notranslate"><span class="pre">__all__</span></code>
+<li><p><strong>Submodule __all__</strong>: Each submodule defines its own <code class="docutils literal notranslate"><span class="pre">__all__</span></code>
 list</p></li>
-<li><p><strong>Subpackage ``__init__.py``</strong>: The subpackage <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> uses
+<li><p><strong>Subpackage __init__.py</strong>: The subpackage <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code> uses
 <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">._module</span> <span class="pre">import</span> <span class="pre">*</span></code> to assemble the package</p></li>
 </ol>
-<p><strong>Example structure for ``_memory/`` subpackage:</strong></p>
+<p><strong>Example structure for _memory/ subpackage:</strong></p>
 <p><code class="docutils literal notranslate"><span class="pre">_memory/_buffer.pyx</span></code>:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Buffer&#39;</span><span class="p">,</span> <span class="s1">&#39;MemoryResource&#39;</span><span class="p">]</span>
 
@@ -873,16 +873,16 @@ <h4>Complex Subpackages<a class="headerlink" href="#complex-subpackages" title="
 <section id="guidelines">
 <h3>Guidelines<a class="headerlink" href="#guidelines" title="Link to this heading">#</a></h3>
 <ol class="arabic simple">
-<li><p><strong>Always create ``.pxd`` files for shared Cython types</strong>: If a class
+<li><p><strong>Always create .pxd files for shared Cython types</strong>: If a class
 or function is <code class="docutils literal notranslate"><span class="pre">cimport</span></code>ed by other modules, provide a <code class="docutils literal notranslate"><span class="pre">.pxd</span></code>
 declaration file.</p></li>
-<li><p><strong>Keep ``.pxd`` files minimal</strong>: Only include declarations needed for
+<li><p><strong>Keep .pxd files minimal</strong>: Only include declarations needed for
 Cython compilation. Omit implementation details, docstrings, and
 Python-only code.</p></li>
-<li><p><strong>Use ``__all__`` when helpful</strong>: Define <code class="docutils literal notranslate"><span class="pre">__all__</span></code> to control
+<li><p><strong>Use __all__ when helpful</strong>: Define <code class="docutils literal notranslate"><span class="pre">__all__</span></code> to control
 exported symbols when it simplifies or clarifies the module
 structure.</p></li>
-<li><p><strong>Use ``from ._module import *`` in subpackage ``__init__.py``</strong>:
+<li><p><strong>Use from ._module import * in subpackage __init__.py</strong>:
 This pattern assembles the subpackage API from its submodules. Use
 <code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">noqa:</span> <span class="pre">F403</span></code> to suppress linting warnings about wildcard imports.</p></li>
 <li><p><strong>Migrate to subpackage structure when complex</strong>: When a top-level
@@ -986,7 +986,7 @@ <h3>Additional Rules<a class="headerlink" href="#additional-rules" title="Link t
 <li><p><strong>Blank Lines</strong>: Use blank lines to separate the five import groups.
 Do not use blank lines within a group unless using multi-line import
 formatting.</p></li>
-<li><p><strong>``try/except`` Blocks</strong>: Import fallbacks (e.g., for optional
+<li><p><strong>try/except blocks</strong>: Import fallbacks (e.g., for optional
 dependencies) should be placed in the appropriate group (external or
 cuda-core) using <code class="docutils literal notranslate"><span class="pre">try/except</span></code> blocks.</p></li>
 </ol>
@@ -1235,11 +1235,11 @@ <h4>Forward References and <code class="docutils literal notranslate"><span clas
 <section id="guidelines-1">
 <span id="id18"></span><h4>Guidelines<a class="headerlink" href="#guidelines-1" title="Link to this heading">#</a></h4>
 <ol class="arabic simple">
-<li><p><strong>Use ``from __future__ import annotations``</strong>: This should be
+<li><p><strong>Use from __future__ import annotations</strong>: This should be
 present in all <code class="docutils literal notranslate"><span class="pre">.py</span></code> and <code class="docutils literal notranslate"><span class="pre">.pyx</span></code> files with type annotations.</p></li>
-<li><p><strong>Use ``|`` for unions</strong>: Prefer <code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">|</span> <span class="pre">Y</span> <span class="pre">|</span> <span class="pre">None</span></code> over
+<li><p><strong>Use | for unions</strong>: Prefer <code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">|</span> <span class="pre">Y</span> <span class="pre">|</span> <span class="pre">None</span></code> over
 <code class="docutils literal notranslate"><span class="pre">Union[X,</span> <span class="pre">Y]</span></code> or <code class="docutils literal notranslate"><span class="pre">Optional[X]</span></code>.</p></li>
-<li><p><strong>Avoid ``TYPE_CHECKING`` blocks</strong>: With
+<li><p><strong>Avoid TYPE_CHECKING blocks</strong>: With
 <code class="docutils literal notranslate"><span class="pre">from</span> <span class="pre">__future__</span> <span class="pre">import</span> <span class="pre">annotations</span></code>, forward references work
 without <code class="docutils literal notranslate"><span class="pre">TYPE_CHECKING</span></code> guards.</p></li>
 <li><p><strong>Import types normally</strong>: Even if a type is only used in
@@ -1572,8 +1572,8 @@ <h2>Errors and Warnings<a class="headerlink" href="#errors-and-warnings" title="
 <h3>CUDA Exceptions<a class="headerlink" href="#cuda-exceptions" title="Link to this heading">#</a></h3>
 <p>The project defines custom exceptions for CUDA-specific errors:</p>
 <ul class="simple">
-<li><p><strong>``CUDAError``</strong>: Base exception for CUDA driver errors</p></li>
-<li><p><strong>``NVRTCError``</strong>: Exception for NVRTC compiler errors (inherits from
+<li><p><strong>CUDAError</strong>: Base exception for CUDA driver errors</p></li>
+<li><p><strong>NVRTCError</strong>: Exception for NVRTC compiler errors (inherits from
 <code class="docutils literal notranslate"><span class="pre">CUDAError</span></code>)</p></li>
 </ul>
 <p>Use these instead of generic exceptions when reporting CUDA failures.</p>

docs/pr-preview/pr-1316/cuda-core/latest/generated/cuda.core.Buffer.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="../_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="../_static/documentation_options.js?v=49139664"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>

docs/pr-preview/pr-1316/cuda-core/latest/generated/cuda.core.Device.html

@@ -44,7 +44,7 @@
 
 
 
-    <script src="../_static/documentation_options.js?v=ed6b127d"></script>
+    <script src="../_static/documentation_options.js?v=49139664"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -53,7 +53,7 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://nvidia.github.io/cuda-python/cuda-core/nv-versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev38';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.5.1.dev39';
         DOCUMENTATION_OPTIONS.show_version_warning_banner =
             false;
         </script>