fix the documentation build error

Author: ksimpson-work

cuda_core/cuda/core/experimental/_system.py

@@ -4,7 +4,11 @@
 from cuda.core.experimental._utils import handle_return
 
 class System:
-    """Represent the system and provide information about the CUDA environment."""
+    """Represent the system and provide information about the CUDA environment.
+
+    This class is a singleton and should not be instantiated directly.
+    Use the provided instance `system` instead.
+    """
 
     def __new__(cls):
         if not cls._instance:
@@ -17,10 +21,13 @@ def __init__(self):
 
     @property
     def driver_version(self) -> Tuple[int, int]:
-        """Query the CUDA driver version.
+        """
+        Query the CUDA driver version.
 
-        Returns:
-            tuple: a 2-tuple of (major, minor).
+        Returns
+        -------
+        tuple of int
+            A 2-tuple of (major, minor) version numbers.
         """
         version = handle_return(cuda.cuDriverGetVersion())
         major = version // 1000
@@ -30,14 +37,28 @@ def driver_version(self) -> Tuple[int, int]:
 
     @property
     def num_devices(self) -> int:
-        """Query the number of available GPUs."""
+        """
+        Query the number of available GPUs.
+
+        Returns
+        -------
+        int
+            The number of available GPU devices.
+        """
         return handle_return(cudart.cudaGetDeviceCount())
 
     @property
     def devices(self) -> tuple:
-        """Query the available device instances."""
+        """
+        Query the available device instances.
+
+        Returns
+        -------
+        tuple of Device
+            A tuple containing instances of available devices.
+        """
         total = self.num_devices
         self._devices = tuple(Device(device_id) for device_id in range(total))
         return self._devices
 
-_system = System.__new__(System)
+_system = System.__new__(System)

cuda_core/docs/source/conf.py

@@ -10,9 +10,20 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
+import sys
+from unittest.mock import MagicMock
 
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+# Add the path to your module
+sys.path.insert(0, os.path.abspath('../..'))
+
+# Mock the cuda module and its submodules
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        return MagicMock()
+
+MOCK_MODULES = ['cuda.core.experimental._system']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 
 # -- Project information -----------------------------------------------------

cuda_core/docs/source/release.md

@@ -6,4 +6,6 @@ maxdepth: 3
 ---
 
     0.1.0 <release/0.1.0-notes>
+    0.2.0 <release/0.2.0-notes>
+
 ```

cuda_core/docs/source/release/0.2.0-notes.md

@@ -0,0 +1,10 @@
+# `cuda.core` Release notes
+
+Released on <TODO>, 2024
+
+## Hightlights
+- Addition of the system singleton
+
+## Limitations
+
+<TODO>

cuda_core/tests/test_system.py

@@ -1,34 +1,35 @@
-# test_system.py
+# test_System.py
 
 try:
     from cuda.bindings import driver, runtime
 except ImportError:
     from cuda import cuda as driver
     from cuda import cudart as runtime
 
-from cuda.core.experimental import Device, system
+from cuda.core.experimental import Device, System
 
 from cuda.core.experimental import Device
 from cuda.core.experimental._utils import handle_return
 
-def test_system_singleton():
-    system1 = system
-    system2 = system
-    assert system1 is system2, "System is not a singleton"
+def test_System_singleton():
+    System1 = System
+    System2 = System
+    assert System1 is System2, "System is not a singleton"
 
 def test_driver_version():
-    driver_version = system.driver_version
+    driver_version = System.driver_version
+    print(driver_version)
     version = handle_return(driver.cuDriverGetVersion())
     expected_driver_version = (version // 1000, (version % 1000) // 10)
     assert driver_version == expected_driver_version, "Driver version does not match expected value"
 
 def test_num_devices():
-    num_devices = system.num_devices
+    num_devices = System.num_devices
     expected_num_devices = handle_return(runtime.cudaGetDeviceCount())
     assert num_devices == expected_num_devices, "Number of devices does not match expected value"
 
 def test_devices():
-    devices = system.devices
+    devices = System.devices
     expected_num_devices = handle_return(runtime.cudaGetDeviceCount())
     expected_devices = tuple(Device(device_id) for device_id in range(expected_num_devices))
     assert len(devices) == len(expected_devices), "Number of devices does not match expected value"