remove @publicapi from GroupedData class to omit its constructor from

documentation Signed-off-by: can <[email protected]>
ray-project · Aug 6, 2024 · 86c850a · 86c850a
1 parent 3ec34e9
commit 86c850a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/doc/source/_templates/autosummary/class_v2.rst b/doc/source/_templates/autosummary/class_v2.rst
@@ -1,9 +1,9 @@
-{{ name }}
-{{ '-' * name | length }}
-
 .. currentmodule:: {{ module }}
 
 {% if name | has_public_constructor(module) %}
+{{ name }}
+{{ '-' * name | length }}
+
 .. autoclass:: {{ objname }}
 {% endif %}
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -448,6 +448,7 @@ def _is_api_group(obj, group):
 FILTERS["filter_out_undoc_class_members"] = filter_out_undoc_class_members
 FILTERS["get_api_groups"] = get_api_groups
 FILTERS["select_api_group"] = select_api_group
+FILTERS["has_public_constructor"] = has_public_constructor
 
 
 def add_custom_assets(