Skip to content

Commit 13292b1

Browse files
committed
Fix DeviceProperties documentation by using cyclass.rst template
DeviceProperties is a Cython cdef class, but was being documented without specifying the cyclass.rst template. This caused Sphinx to use the default class template which uses autoproperty, which doesn't work correctly with Cython extension types. The cyclass.rst template uses autoattribute instead, which properly documents the properties of Cython classes. Fixes #1215
1 parent 2ed3f98 commit 13292b1

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

cuda_core/docs/source/api_private.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,17 @@ CUDA runtime
2222
_memory._virtual_memory_resource.VirtualMemoryGranularityT
2323
_memory._virtual_memory_resource.VirtualMemoryAccessTypeT
2424
_memory._virtual_memory_resource.VirtualMemoryHandleTypeT
25-
_device.DeviceProperties
2625
_memory._ipc.IPCAllocationHandle
2726
_memory._ipc.IPCBufferDescriptor
2827
_module.KernelAttributes
2928
_module.KernelOccupancy
3029
_module.ParamInfo
3130
_module.MaxPotentialBlockSizeOccupancyResult
3231

32+
:template: autosummary/cyclass.rst
33+
34+
_device.DeviceProperties
35+
3336

3437
CUDA protocols
3538
--------------

0 commit comments

Comments
 (0)