From f00fdd07943032b8bb4199bc22d826e6c914029e Mon Sep 17 00:00:00 2001
From: "panxuchen.pxc" <panxuchen.pxc@alibaba-inc.com>
Date: Mon, 22 Jan 2024 12:08:28 +0800
Subject: [PATCH] refactor sphinx doc workflow

---
 .github/workflows/sphinx_docs.yml            | 20 +++++-----
 docs/sphinx_doc/source/agentscope.agents.rst | 40 ++++++++++++++++++++
 2 files changed, 50 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/sphinx_docs.yml b/.github/workflows/sphinx_docs.yml
index 1235218e0..313d1dfd2 100644
--- a/.github/workflows/sphinx_docs.yml
+++ b/.github/workflows/sphinx_docs.yml
@@ -18,27 +18,27 @@ jobs:
       OS: ${{ matrix.os }}
       PYTHON: '3.9'
     steps:
-    - name: Checkout repository
+    - name: Checkout Repository
       uses: actions/checkout@master
     - name: Setup Python ${{ matrix.python-version }}
       uses: actions/setup-python@master
       with:
         python_version: ${{ matrix.python-version }}
-    - id: deployment
+    - name: Install Dependencies
+      run: |
+        pip install -q -e .[full]
+    - id: build
       name: Build Documentation
-      uses: sphinx-notes/pages@v3
-      with:
-        documentation_path: ./docs/sphinx_doc/source
-        python_version: ${{ matrix.python-version }}
-        publish: false
-        requirements_path: ./docs/sphinx_doc/requirements.txt
+      run: |
+        cd docs/sphinx_doc
+        make clean html
     - name: Upload Documentation
       uses: actions/upload-artifact@v3
       with:
         name: SphinxDoc
-        path: ${{ steps.deployment.outputs.artifact }}
+        path: 'docs/sphinx_doc/build'
     - uses: peaceiris/actions-gh-pages@v3
       if: ${{ github.event_name == 'push' }}
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ${{ steps.deployment.outputs.artifact }}
\ No newline at end of file
+        publish_dir: 'docs/sphinx_doc/build'
\ No newline at end of file
diff --git a/docs/sphinx_doc/source/agentscope.agents.rst b/docs/sphinx_doc/source/agentscope.agents.rst
index d8c576d1a..0b6520701 100644
--- a/docs/sphinx_doc/source/agentscope.agents.rst
+++ b/docs/sphinx_doc/source/agentscope.agents.rst
@@ -1,6 +1,14 @@
 Agents package
 ==========================
 
+operator module
+-------------------------------
+
+.. automodule:: agentscope.agents.operator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 agent module
 -------------------------------
 
@@ -13,6 +21,38 @@ rpc_agent module
 -------------------------------
 
 .. automodule:: agentscope.agents.rpc_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+user_agent module
+-------------------------------
+
+.. automodule:: agentscope.agents.user_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dialog_agent module
+-------------------------------
+
+.. automodule:: agentscope.agents.dialog_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dict_dialog_agent module
+-------------------------------
+
+.. automodule:: agentscope.agents.dict_dialog_agent
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+rpc_dialog_agent module
+-------------------------------
+
+.. automodule:: agentscope.agents.dict_dialog_agent
    :members:
    :undoc-members:
    :show-inheritance:
\ No newline at end of file