Skip to content

Commit 1ae0ef0

Browse files
Fix missing class members in generated documentation
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 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).
1 parent 69aac67 commit 1ae0ef0

File tree

1 file changed

+3
-0
lines changed
  • cuda_core/docs/source/_templates/autosummary

1 file changed

+3
-0
lines changed

cuda_core/docs/source/_templates/autosummary/class.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
.. currentmodule:: {{ module }}
77

88
.. autoclass:: {{ objname }}
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
912

1013
{% block methods %}
1114
{% if methods %}

0 commit comments

Comments
 (0)