[data] add api doc for dataset.Schema class (#46170)

Add API doc for dataset.Schema, which is a publicapi class Test: - CI Signed-off-by: can <[email protected]>
ray-project · Jun 21, 2024 · dc5ecdb · dc5ecdb
1 parent 1e87d35
commit dc5ecdb
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/doc/source/_templates/autosummary/class_without_autosummary_noindex.rst b/doc/source/_templates/autosummary/class_without_autosummary_noindex.rst
@@ -0,0 +1,8 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+    :members:
+    :noindex:
+    :show-inheritance:
diff --git a/doc/source/data/api/dataset.rst b/doc/source/data/api/dataset.rst
@@ -141,6 +141,16 @@ Execution
 
     Dataset.materialize
 
+Schema
+------
+
+.. autosummary::
+   :nosignatures:
+   :toctree: doc/
+   :template: autosummary/class_without_autosummary_noindex.rst
+
+   Schema
+
 .. _block-api:
 
 Internals