Skip to content

Commit b51b79c

Browse files
committed
Fix documented enums in cuda_core
1 parent e20ef78 commit b51b79c

File tree

2 files changed

+41
-19
lines changed

2 files changed

+41
-19
lines changed

cuda_core/docs/source/api.rst

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ CUDA compilation toolchain
8282
CUDA system information and NVIDIA Management Library (NVML)
8383
------------------------------------------------------------
8484

85+
Basic functions
86+
```````````````
87+
8588
.. autosummary::
8689
:toctree: generated/
8790

@@ -94,35 +97,61 @@ CUDA system information and NVIDIA Management Library (NVML)
9497
system.get_topology_common_ancestor
9598
system.get_p2p_status
9699

100+
Events
101+
``````
102+
103+
.. autosummary::
104+
:toctree: generated/
105+
97106
system.register_events
98107
system.RegisteredSystemEvents
99108
system.SystemEvent
100109
system.SystemEvents
101110
system.SystemEventType
102111

103-
:template: autosummary/cyclass.rst
112+
Enums
113+
`````
114+
115+
.. autosummary::
116+
:toctree: generated/
104117

105-
system.Device
106118
system.AddressingMode
107119
system.AffinityScope
108-
system.BAR1MemoryInfo
109120
system.BrandType
110121
system.ClockId
111-
system.ClockInfo
112-
system.ClockOffsets
113122
system.ClocksEventReasons
114-
system.ClockType
115123
system.CoolerControl
116-
system.CoolerInfo
117124
system.CoolerTarget
118125
system.DeviceArch
126+
system.EventType
127+
system.FanControlPolicy
128+
system.FieldId
129+
system.InforomObject
130+
system.PcieUtilCounter
131+
system.Pstates
132+
system.TemperatureSensors
133+
system.TemperatureThresholds
134+
system.ThermalController
135+
system.ThermalTarget
136+
137+
Types
138+
`````
139+
140+
.. autosummary::
141+
:toctree: generated/
142+
143+
:template: autosummary/cyclass.rst
144+
145+
system.Device
146+
system.BAR1MemoryInfo
147+
system.ClockInfo
148+
system.ClockOffsets
149+
system.ClockType
150+
system.CoolerInfo
119151
system.DeviceAttributes
120152
system.DeviceEvents
121153
system.EventData
122-
system.EventType
123-
system.FanControlPolicy
124154
system.FanInfo
125-
system.FieldId
126155
system.FieldValue
127156
system.FieldValues
128157
system.GpuDynamicPstatesInfo
@@ -131,19 +160,12 @@ CUDA system information and NVIDIA Management Library (NVML)
131160
system.GpuP2PStatus
132161
system.GpuTopologyLevel
133162
system.InforomInfo
134-
system.InforomObject
135163
system.MemoryInfo
136-
system.PcieUtilCounter
137164
system.PciInfo
138-
system.Pstates
139165
system.RepairStatus
140166
system.Temperature
141-
system.TemperatureSensors
142-
system.TemperatureThresholds
143-
system.ThermalController
144167
system.ThermalSensor
145168
system.ThermalSettings
146-
system.ThermalTarget
147169

148170
.. module:: cuda.core.utils
149171

cuda_core/docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
1+
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
# SPDX-License-Identifier: Apache-2.0
33

44
# Configuration file for the Sphinx documentation builder.
@@ -37,11 +37,11 @@
3737
"sphinx.ext.napoleon",
3838
"sphinx.ext.intersphinx",
3939
"myst_nb",
40-
"enum_tools.autoenum",
4140
"sphinx_copybutton",
4241
"sphinx_toolbox.more_autodoc.autoprotocol",
4342
"release_toc",
4443
"release_date",
44+
"enum_documenter",
4545
]
4646

4747
# Add any paths that contain templates here, relative to this directory.

0 commit comments

Comments
 (0)