Update docs for v0.3.1 release (#695)

* move public types out of api_private.rst

* bump version

* add release note

* fix typo

---------

Co-authored-by: Leo Fang <[email protected]>

Author: rwgk

cuda_core/cuda/core/_version.py

@@ -2,4 +2,4 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"

cuda_core/cuda/core/experimental/__init__.py

@@ -15,7 +15,7 @@
 from cuda.core.experimental._launcher import launch
 from cuda.core.experimental._linker import Linker, LinkerOptions
 from cuda.core.experimental._memory import Buffer, DeviceMemoryResource, LegacyPinnedMemoryResource, MemoryResource
-from cuda.core.experimental._module import ObjectCode
+from cuda.core.experimental._module import Kernel, ObjectCode
 from cuda.core.experimental._program import Program, ProgramOptions
 from cuda.core.experimental._stream import Stream, StreamOptions
 from cuda.core.experimental._system import System

cuda_core/docs/source/api.rst

@@ -45,6 +45,7 @@ CUDA compilation toolchain
    Program
    Linker
    ObjectCode
+   Kernel
 
    :template: dataclass.rst
 

cuda_core/docs/source/api_private.rst

@@ -15,26 +15,15 @@ CUDA runtime
 .. autosummary::
    :toctree: generated/
 
-   _stream.Stream
    _memory.PyCapsule
    _memory.DevicePointerT
-   _event.Event
    _device.DeviceProperties
    _module.KernelAttributes
    _module.KernelOccupancy
    _module.ParamInfo
    _module.MaxPotentialBlockSizeOccupancyResult
 
 
-CUDA compilation toolchain
---------------------------
-
-.. autosummary::
-   :toctree: generated/
-
-   _module.Kernel
-
-
 CUDA protocols
 --------------
 

cuda_core/docs/source/release.rst

@@ -6,6 +6,7 @@ Release Notes
 .. toctree::
    :maxdepth: 3
 
+   release/0.3.1-notes
    release/0.3.0-notes
    release/0.2.0-notes
    release/0.1.1-notes

cuda_core/docs/source/release/0.3.1-notes.rst

@@ -0,0 +1,44 @@
+.. SPDX-License-Identifier: Apache-2.0
+
+.. currentmodule:: cuda.core.experimental
+
+``cuda.core`` 0.3.1 Release Notes
+=================================
+
+Released on July 2, 2025
+
+
+Highlights
+----------
+
+- Add a :doc:`Getting Started <getting-started>` page.
+- :class:`Stream` and :class:`Event` creation and some operations are made faster.
+
+
+Breaking Changes
+----------------
+
+None.
+
+
+New features
+------------
+
+None.
+
+
+New examples
+------------
+
+- Add a `CUDA graph <https://github.com/NVIDIA/cuda-python/blob/main/cuda_core/examples/cuda_graphs.py>`_ example.
+- Add a `memory resource <https://github.com/NVIDIA/cuda-python/blob/main/cuda_core/examples/memory_ops.py>`_ example.
+
+
+Fixes and enhancements
+----------------------
+
+- Fix installing optional dependencies ``cuda-core[cu11]`` and ``cuda-core[cu12]`` not including all needed packages.
+- :class:`Buffer` allocated from a :class:`LegacyPinnedMemoryResource` can be passed as a kernel launch argument.
+- Fix the handling for insufficient driver versions when querying :attr:`Kernel.num_arguments` and :attr:`Kernel.arguments_info`.
+- Fix WSL detection in the test suite.
+- Improve compatibility with newer driver versions.

cuda_core/docs/versions.json

@@ -1,5 +1,6 @@
 {
     "latest"  : "latest",
+    "0.3.1"   : "0.3.1",
     "0.3.0"   : "0.3.0",
     "0.2.0"   : "0.2.0",
     "0.1.1"   : "0.1.1",