Skip to content

Fix documented enums in cuda_core #1784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cpcloud merged 1 commit into from
Mar 17, 2026
Merged

Fix documented enums in cuda_core #1784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 39 additions & 17 deletions cuda_core/docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ CUDA compilation toolchain
CUDA system information and NVIDIA Management Library (NVML)
------------------------------------------------------------

Basic functions
```````````````

.. autosummary::
:toctree: generated/

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

Events
``````

.. autosummary::
:toctree: generated/

system.register_events
system.RegisteredSystemEvents
system.SystemEvent
system.SystemEvents
system.SystemEventType

:template: autosummary/cyclass.rst
Enums
`````

.. autosummary::
:toctree: generated/

system.Device
system.AddressingMode
system.AffinityScope
system.BAR1MemoryInfo
system.BrandType
system.ClockId
system.ClockInfo
system.ClockOffsets
system.ClocksEventReasons
system.ClockType
system.CoolerControl
system.CoolerInfo
system.CoolerTarget
system.DeviceArch
system.EventType
system.FanControlPolicy
system.FieldId
system.InforomObject
system.PcieUtilCounter
system.Pstates
system.TemperatureSensors
system.TemperatureThresholds
system.ThermalController
system.ThermalTarget

Types
`````

.. autosummary::
:toctree: generated/

:template: autosummary/cyclass.rst

system.Device
system.BAR1MemoryInfo
system.ClockInfo
system.ClockOffsets
system.ClockType
system.CoolerInfo
system.DeviceAttributes
system.DeviceEvents
system.EventData
system.EventType
system.FanControlPolicy
system.FanInfo
system.FieldId
system.FieldValue
system.FieldValues
system.GpuDynamicPstatesInfo
Expand All @@ -131,19 +160,12 @@ CUDA system information and NVIDIA Management Library (NVML)
system.GpuP2PStatus
system.GpuTopologyLevel
system.InforomInfo
system.InforomObject
system.MemoryInfo
system.PcieUtilCounter
system.PciInfo
system.Pstates
system.RepairStatus
system.Temperature
system.TemperatureSensors
system.TemperatureThresholds
system.ThermalController
system.ThermalSensor
system.ThermalSettings
system.ThermalTarget

.. module:: cuda.core.utils

Expand Down
4 changes: 2 additions & 2 deletions cuda_core/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

# Configuration file for the Sphinx documentation builder.
Expand Down Expand Up @@ -37,11 +37,11 @@
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"myst_nb",
"enum_tools.autoenum",
"sphinx_copybutton",
"sphinx_toolbox.more_autodoc.autoprotocol",
"release_toc",
"release_date",
"enum_documenter",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
Loading