[Docs] Refactor Ray Workflows API documentation (ray-project#32248) (r…

…ay-project#32275)
cadedaniel · Feb 7, 2023 · 860335b · 860335b
1 parent f0aee91
commit 860335b
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 23 deletions.
diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml
@@ -357,7 +357,7 @@ parts:
               - file: workflows/events
               - file: workflows/comparison
               - file: workflows/advanced
-              - file: workflows/package-ref
+              - file: workflows/api/api
 
       - file: ray-observability/monitoring-debugging/monitoring-debugging
         title: "Monitoring and Debugging"

diff --git a/doc/source/ray-references/api.rst b/doc/source/ray-references/api.rst
@@ -11,6 +11,6 @@ API References
     ../tune/api_docs/overview.rst
     ../serve/package-ref.rst
     ../rllib/package_ref/index.rst
-    ../workflows/package-ref.rst
+    ../workflows/api/api.rst
     ../cluster/package-overview.rst
     ../ray-core/package-ref.rst
diff --git a/doc/source/workflows/api/api.rst b/doc/source/workflows/api/api.rst
@@ -0,0 +1,8 @@
+Ray Workflows API
+=================
+
+.. toctree::
+    :maxdepth: 1
+
+    execution.rst
+    management.rst
diff --git a/doc/source/workflows/api/execution.rst b/doc/source/workflows/api/execution.rst
@@ -0,0 +1,10 @@
+Workflow Execution API
+======================
+
+.. currentmodule:: ray.workflow
+
+.. autosummary::
+   :toctree: doc/
+
+   run
+   run_async
diff --git a/doc/source/workflows/api/management.rst b/doc/source/workflows/api/management.rst
@@ -0,0 +1,17 @@
+Workflow Management API
+=======================
+
+.. currentmodule:: ray.workflow
+
+.. autosummary::
+   :toctree: doc/
+
+   resume
+   resume_async
+   resume_all
+   list_all
+   get_status
+   get_output
+   get_output_async
+   get_metadata
+   cancel
diff --git a/doc/source/workflows/package-ref.rst b/doc/source/workflows/package-ref.rst