[Datasets] Refactor Ray Data API documentation (#31204)

ray-project · Jan 12, 2023 · 58f349d · 58f349d
1 parent 775a752
commit 58f349d
Show file tree

Hide file tree

Showing 12 changed files with 390 additions and 562 deletions.
diff --git a/doc/source/_static/css/custom.css b/doc/source/_static/css/custom.css
@@ -245,8 +245,13 @@ th.tune-colab {
 
 /* Adjustment to Sphinx Book Theme */
 .table td {
- /* Remove row spacing */
- padding: 0;
+ /* Remove row spacing on the left */
+ padding-left: 0;
+}
+
+.table thead th {
+ /* Remove row spacing on the left */
+ padding-left: 0;
 }
 
 img.inline-figure {

diff --git a/doc/source/data/api/data_representations.rst b/doc/source/data/api/data_representations.rst
@@ -3,54 +3,49 @@
 Data Representations
 ====================
 
+.. currentmodule:: ray.data
+
 .. _block-api:
 
 Block API
 ---------
 
-.. autoclass:: ray.data.block.Block
-
-.. autoclass:: ray.data.block.BlockExecStats
- :members:
-
-.. autoclass:: ray.data.block.BlockMetadata
- :members:
-
-.. autoclass:: ray.data.block.BlockAccessor
- :members:
+.. autosummary::
+ :toctree: doc/
 
+ block.Block
+ block.BlockExecStats
+ block.BlockMetadata
+ block.BlockAccessor
 
 Batch API
 ---------
 
-.. autoclass:: ray.data.block.DataBatch
+.. autosummary::
+ :toctree: doc/
+
+ block.DataBatch
 
 Row API
 --------
 
-.. autoclass:: ray.data.row.TableRow
-  :members:
+.. autosummary::
+ :toctree: doc/
 
+ row.TableRow
 
 .. _dataset-tensor-extension-api:
 
 Tensor Column Extension API
 ---------------------------
 
-.. autoclass:: ray.data.extensions.tensor_extension.TensorDtype
- :members:
-
-.. autoclass:: ray.data.extensions.tensor_extension.TensorArray
- :members:
-
-.. autoclass:: ray.data.extensions.tensor_extension.ArrowTensorType
- :members:
-
-.. autoclass:: ray.data.extensions.tensor_extension.ArrowTensorArray
- :members:
+.. autosummary::
+ :toctree: doc/
 
-.. autoclass:: ray.data.extensions.tensor_extension.ArrowVariableShapedTensorType
- :members:
+ extensions.tensor_extension.TensorDtype
+ extensions.tensor_extension.TensorArray
+ extensions.tensor_extension.ArrowTensorType
+ extensions.tensor_extension.ArrowTensorArray
+ extensions.tensor_extension.ArrowVariableShapedTensorType
+ extensions.tensor_extension.ArrowVariableShapedTensorArray
 
-.. autoclass:: ray.data.extensions.tensor_extension.ArrowVariableShapedTensorArray
- :members: