From 860335b2dc3799ebdd66f405a46fae9520a87572 Mon Sep 17 00:00:00 2001
From: Cheng Su <scnju13@gmail.com>
Date: Tue, 7 Feb 2023 12:20:04 -0800
Subject: [PATCH] [Docs] Refactor Ray Workflows API documentation (#32248)
 (#32275)

---
 doc/source/_toc.yml                     |  2 +-
 doc/source/ray-references/api.rst       |  2 +-
 doc/source/workflows/api/api.rst        |  8 ++++++++
 doc/source/workflows/api/execution.rst  | 10 ++++++++++
 doc/source/workflows/api/management.rst | 17 +++++++++++++++++
 doc/source/workflows/package-ref.rst    | 21 ---------------------
 6 files changed, 37 insertions(+), 23 deletions(-)
 create mode 100644 doc/source/workflows/api/api.rst
 create mode 100644 doc/source/workflows/api/execution.rst
 create mode 100644 doc/source/workflows/api/management.rst
 delete mode 100644 doc/source/workflows/package-ref.rst

diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml
index 223b1f9276ba2..4975ca63a1126 100644
--- 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
index 6aef18962dbc6..2e97eac3dfbab 100644
--- 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
new file mode 100644
index 0000000000000..b9c78ded0556b
--- /dev/null
+++ 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
new file mode 100644
index 0000000000000..e4c4a42afdf7f
--- /dev/null
+++ b/doc/source/workflows/api/execution.rst
@@ -0,0 +1,10 @@
+Workflow Execution API
+======================
+
+.. currentmodule:: ray.workflow
+
+.. autosummary::
+   :toctree: doc/
+
+   run
+   run_async
\ No newline at end of file
diff --git a/doc/source/workflows/api/management.rst b/doc/source/workflows/api/management.rst
new file mode 100644
index 0000000000000..e934c980d8bf2
--- /dev/null
+++ 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
\ No newline at end of file
diff --git a/doc/source/workflows/package-ref.rst b/doc/source/workflows/package-ref.rst
deleted file mode 100644
index 44a88f41ca1b0..0000000000000
--- a/doc/source/workflows/package-ref.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-Ray Workflows API
-=================
-
-Workflow Execution API
-----------------------
-
-.. autofunction:: ray.workflow.run
-.. autofunction:: ray.workflow.run_async
-
-
-Management API
---------------
-.. autofunction:: ray.workflow.resume
-.. autofunction:: ray.workflow.resume_async
-.. autofunction:: ray.workflow.resume_all
-.. autofunction:: ray.workflow.list_all
-.. autofunction:: ray.workflow.get_status
-.. autofunction:: ray.workflow.get_output
-.. autofunction:: ray.workflow.get_output_async
-.. autofunction:: ray.workflow.get_metadata
-.. autofunction:: ray.workflow.cancel