Skip to content

Fix documentation: DeviceProperties display and sidebar navigation #1444

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
kkraus14 merged 14 commits into from
Jan 10, 2026
Merged

Fix documentation: DeviceProperties display and sidebar navigation #1444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
162649c
Fix DeviceProperties documentation by using cyclass.rst template
kkraus14 Jan 9, 2026
1317c56
Enable object entries in table of contents for sidebar navigation
kkraus14 Jan 9, 2026
04c8a1e
List class members directly without separate sections in autosummary …
kkraus14 Jan 9, 2026
bdf35a6
Show class prefix in sidebar TOC, plain names in main docs
kkraus14 Jan 9, 2026
d5c730e
Use autoclass :members: option for automatic member documentation
kkraus14 Jan 9, 2026
69d9055
Use section headings for methods/attributes to appear in sidebar TOC
kkraus14 Jan 9, 2026
972ed62
Fix autodoc directives to use fully qualified names
kkraus14 Jan 9, 2026
284df91
Use autoclass :members: with toc_object_entries for sidebar
kkraus14 Jan 9, 2026
a125fbd
Restore original template structure with rubrics
kkraus14 Jan 9, 2026
c5ea511
Configure pydata-sphinx-theme secondary sidebar for autodoc entries
kkraus14 Jan 9, 2026
37cc656
Remove sourcelink from secondary sidebar
kkraus14 Jan 9, 2026
c2c0979
Apply cyclass.rst template to all Cython cdef classes
kkraus14 Jan 9, 2026
e1e7df1
Fix template assignments: dataclasses stay under dataclass.rst
kkraus14 Jan 9, 2026
0ad1a8a
Move LaunchConfig to dataclass template
kkraus14 Jan 9, 2026
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
10 changes: 10 additions & 0 deletions cuda_bindings/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# Include object entries (methods, attributes, etc.) in the table of contents
# This enables the "On This Page" sidebar to show class methods and properties
# Requires Sphinx 5.1+
toc_object_entries = True
toc_object_entries_show_parents = "domain"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -69,6 +75,10 @@
"version-switcher",
"navbar-nav",
],
# Use custom secondary sidebar that includes autodoc entries
"secondary_sidebar_items": ["page-toc"],
# Show more TOC levels by default
"show_toc_level": 3,
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
Expand Down
18 changes: 10 additions & 8 deletions cuda_core/docs/source/_templates/autosummary/cyclass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@

.. autoclass:: {{ objname }}

{% block attributes %}
{% if attributes %}
{% for item in attributes %}
.. autoattribute:: {{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block methods %}
{% if methods %}
.. rubric:: {{ _('Methods') }}
Expand All @@ -25,3 +17,13 @@

{% endif %}
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}

{% for item in attributes %}
.. autoattribute:: {{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
3 changes: 3 additions & 0 deletions cuda_core/docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ CUDA runtime
Graph
GraphBuilder
launch

:template: autosummary/cyclass.rst

Buffer
Stream
Event
Expand Down
9 changes: 6 additions & 3 deletions cuda_core/docs/source/api_private.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,17 @@ CUDA runtime
_memory._virtual_memory_resource.VirtualMemoryGranularityT
_memory._virtual_memory_resource.VirtualMemoryAccessTypeT
_memory._virtual_memory_resource.VirtualMemoryHandleTypeT
_device.DeviceProperties
_memory._ipc.IPCAllocationHandle
_memory._ipc.IPCBufferDescriptor
_module.KernelAttributes
_module.KernelOccupancy
_module.ParamInfo
_module.MaxPotentialBlockSizeOccupancyResult

:template: autosummary/cyclass.rst

_device.DeviceProperties
_memory._ipc.IPCAllocationHandle
_memory._ipc.IPCBufferDescriptor


CUDA protocols
--------------
Expand Down
10 changes: 10 additions & 0 deletions cuda_core/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# Include object entries (methods, attributes, etc.) in the table of contents
# This enables the "On This Page" sidebar to show class methods and properties
# Requires Sphinx 5.1+
toc_object_entries = True
toc_object_entries_show_parents = "domain"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -67,6 +73,10 @@
"version-switcher",
"navbar-nav",
],
# Use custom secondary sidebar that includes autodoc entries
"secondary_sidebar_items": ["page-toc"],
# Show more TOC levels by default
"show_toc_level": 3,
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
Expand Down
10 changes: 10 additions & 0 deletions cuda_pathfinder/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# Include object entries (methods, attributes, etc.) in the table of contents
# This enables the "On This Page" sidebar to show class methods and properties
# Requires Sphinx 5.1+
toc_object_entries = True
toc_object_entries_show_parents = "domain"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -70,6 +76,10 @@
"version-switcher",
"navbar-nav",
],
# Use custom secondary sidebar that includes autodoc entries
"secondary_sidebar_items": ["page-toc"],
# Show more TOC levels by default
"show_toc_level": 3,
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
Expand Down
10 changes: 10 additions & 0 deletions cuda_python/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# Include object entries (methods, attributes, etc.) in the table of contents
# This enables the "On This Page" sidebar to show class methods and properties
# Requires Sphinx 5.1+
toc_object_entries = True
toc_object_entries_show_parents = "domain"

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -63,6 +69,10 @@
"version-switcher",
"navbar-nav",
],
# Use custom secondary sidebar that includes autodoc entries
"secondary_sidebar_items": ["page-toc"],
# Show more TOC levels by default
"show_toc_level": 3,
}
if os.environ.get("CI"):
if int(os.environ.get("BUILD_PREVIEW", 0)):
Expand Down
Loading