Fix missing class members in generated documentation #1230
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes NVIDIA#1215 and NVIDIA#1100 After switching to nvidia-sphinx-theme in PR NVIDIA#874, class members (properties, methods, attributes) were no longer being documented in the generated HTML pages. This affected DeviceProperties and other classes using the autosummary class template. Root cause: The autoclass directive in the template was not configured to document members. Added :members:, :undoc-members:, and :show-inheritance: options to ensure all class members are properly documented. Changes: - Added :members: option to include all class members - Added :undoc-members: to include members without docstrings - Added :show-inheritance: to display base classes This restores the documentation to how it appeared before the theme switch (see v0.3.2 for comparison).
Contributor
Contributor
|
/ok to test |
Contributor
@cpcloud, there was an error processing your request: See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/ |
Contributor
|
/ok to test 1ae0ef0 |
|
cpcloud
requested changes
Nov 10, 2025
Contributor
cpcloud
left a comment
cpcloud
left a comment
There was a problem hiding this comment.
Attributes are still not showing up on the right hand side of the page here: https://nvidia.github.io/cuda-python/pr-preview/pr-1230/cuda-core/latest/generated/cuda.core.experimental._device.DeviceProperties.html#cuda.core.experimental._device.DeviceProperties
leofang
added
bug
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1215 and #1100
After switching to nvidia-sphinx-theme in PR #874, class members (properties, methods, attributes) were no longer being documented in the generated HTML pages. This affected
DevicePropertiesand other classes using the autosummary class template.Root Cause
The
autoclassdirective in the template (cuda_core/docs/source/_templates/autosummary/class.rst) was not configured to document members. Without the:members:option, Sphinx's autodoc extension only generates the class signature but no member documentation.Changes
Added three Sphinx autodoc options to the class template:
:members:- Include all class members in the documentation:undoc-members:- Include members without docstrings:show-inheritance:- Display base classesTesting
This change affects all classes documented using the autosummary class template. The fix restores member documentation to how it appeared before the theme switch (compare with v0.3.2 documentation).
Example affected classes:
DeviceProperties(153 properties)Deviceand other classes using the templateBefore/After
Before (current): DeviceProperties page shows only the class docstring with no attributes listed.
After (with this fix): DeviceProperties page shows all 153 property attributes with their docstrings, matching the v0.3.2 documentation format.