Debug rendering of dpnp.exceptions.DLPackCreationError

Author: antonwolfy

doc/reference/exceptions.rst

@@ -6,16 +6,25 @@ Exceptions and Warnings
 General exceptions used by DPNP. Note that some exceptions may be module
 specific, such as linear algebra errors.
 
-.. currentmodule:: dpnp.exceptions
+.. .. currentmodule:: dpnp.exceptions
 
 Exceptions
 ----------
 
-.. data:: AxisError
+.. automodule:: dpnp.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. .. data:: AxisError
 
-    Given when an axis is invalid.
+..     Given when an axis is invalid.
 
-.. data:: DLPackCreationError
+.. .. data:: DLPackCreationError
+
+.. autoclass:: dpnp.exceptions.DLPackCreationError
+   :show-inheritance:
+   :noindex:
 
     Given when constructing DLPack capsule from either :class:`dpnp.ndarray` or
     :class:`dpctl.tensor.usm_ndarray` based on a USM allocation
@@ -36,35 +45,35 @@ Exceptions
         ...
         DLPackCreationError: to_dlpack_capsule: DLPack can only export arrays based on USM allocations bound to a default platform SYCL context
 
-.. data:: ExecutionPlacementError
+.. .. data:: ExecutionPlacementError
 
-    Given when execution placement target can not be unambiguously determined
-    from input arrays. Make sure that input arrays are associated with the same
-    :class:`dpctl.SyclQueue`, or migrate data to the same
-    :class:`dpctl.SyclQueue` using :meth:`dpnp.ndarray.to_device` method.
+..     Given when execution placement target can not be unambiguously determined
+..     from input arrays. Make sure that input arrays are associated with the same
+..     :class:`dpctl.SyclQueue`, or migrate data to the same
+..     :class:`dpctl.SyclQueue` using :meth:`dpnp.ndarray.to_device` method.
 
-.. data:: SyclContextCreationError
+.. .. data:: SyclContextCreationError
 
-    Given when :class:`dpctl.SyclContext` instance could not be created.
+..     Given when :class:`dpctl.SyclContext` instance could not be created.
 
-.. data:: SyclDeviceCreationError
+.. .. data:: SyclDeviceCreationError
 
-    Given when :class:`dpctl.SyclDevice` instance could not be created.
+..     Given when :class:`dpctl.SyclDevice` instance could not be created.
 
-.. data:: SyclQueueCreationError
+.. .. data:: SyclQueueCreationError
 
-    Given when :class:`dpctl.SyclQueue` instance could not be created.
-    The creation can fail if the filter string is invalid, or the backend or
-    device type values are not supported.
+..     Given when :class:`dpctl.SyclQueue` instance could not be created.
+..     The creation can fail if the filter string is invalid, or the backend or
+..     device type values are not supported.
 
-.. data:: USMAllocationError
+.. .. data:: USMAllocationError
 
-    Given when Unified Shared Memory (USM) allocation call returns a null
-    pointer, signaling a failure to perform the allocation.
-    Some common reasons for allocation failure are:
+..     Given when Unified Shared Memory (USM) allocation call returns a null
+..     pointer, signaling a failure to perform the allocation.
+..     Some common reasons for allocation failure are:
 
-        * insufficient free memory to perform the allocation request
-        * allocation size exceeds the maximum supported by targeted backend
+..         * insufficient free memory to perform the allocation request
+..         * allocation size exceeds the maximum supported by targeted backend
 
-.. automodule:: dpnp.exceptions
-    :no-index:
+.. .. automodule:: dpnp.exceptions
+..     :no-index: