From dc5ecdb31f1dddd94fc6350b95f2f6f6a472208c Mon Sep 17 00:00:00 2001 From: Cuong Nguyen <128072568+can-anyscale@users.noreply.github.com> Date: Fri, 21 Jun 2024 13:52:24 -0700 Subject: [PATCH] [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 --- .../autosummary/class_without_autosummary_noindex.rst | 8 ++++++++ doc/source/data/api/dataset.rst | 10 ++++++++++ 2 files changed, 18 insertions(+) create mode 100644 doc/source/_templates/autosummary/class_without_autosummary_noindex.rst diff --git a/doc/source/_templates/autosummary/class_without_autosummary_noindex.rst b/doc/source/_templates/autosummary/class_without_autosummary_noindex.rst new file mode 100644 index 000000000000..c840325b90c2 --- /dev/null +++ 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 index ff9ca5e9c7cd..40f32e802d37 100644 --- 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