Update the tutorial of AgentScope (#508)

Co-authored-by: AgentScope Team
modelscope · Jan 8, 2025 · 39f2d85 · 39f2d85
1 parent 7164d76
commit 39f2d85
Show file tree

Hide file tree

Showing 122 changed files with 6,077 additions and 10,510 deletions.
diff --git a/.github/workflows/sphinx_docs.yml b/.github/workflows/sphinx_docs.yml
@@ -1,16 +1,12 @@
 name: Deploy Sphinx documentation to Pages
 
 on:
-  pull_request:
-    types: [opened, synchronize]
-    paths:
-      - 'docs/**/*'
   push:
     branches:
       - main
 
 jobs:
-  pages:
+  build_tutorial:
     timeout-minutes: 20
     runs-on: ${{ matrix.os }}
     strategy:
@@ -32,19 +28,24 @@ jobs:
     - name: Install Dependencies
       run: |
         pip install -q -e .[full]
-    - id: build
-      name: Build Documentation
+    - name: Add execute permission to build.sh
       run: |
-        cd docs/sphinx_doc
-        ./build_sphinx_doc.sh
+        chmod +x docs/tutorial/en/build.sh
+    - id: build_en
+      name: Build English Documentation
+      env:
+        DASHSCOPE_API_KEY: ${{ secrets.DASHSCOPE_API_KEY }}
+      run: |
+        cd docs/tutorial/en/
+        ./build.sh
     - name: Upload Documentation
       uses: actions/upload-artifact@v4
       with:
         name: SphinxDoc
-        path: 'docs/sphinx_doc/build'
+        path: 'docs/tutorial/en/build'
     - uses: peaceiris/actions-gh-pages@v3
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: 'docs/sphinx_doc/build/html'
-        cname: doc.agentscope.io
+        publish_dir: 'docs/tutorial/en/build/html'
+        cname: doc.agentscope.io
diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
@@ -36,4 +36,4 @@ jobs:
         coverage run tests/run.py
     - name: Generate coverage report
       run: |
-        coverage report -m
+        coverage report -m
diff --git a/.gitignore b/.gitignore
@@ -134,7 +134,8 @@ dmypy.json
 .DS_Store
 
 # docs
-docs/sphinx_doc/build/
+docs/tutorial/en/build/
+docs/tutorial/zh/build/
 
 # Used to save loggings and files
 *runs/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -57,6 +57,7 @@ repos:
     hooks:
       - id: flake8
         args: ["--extend-ignore=E203"]
+        exclude: ^docs
   - repo: https://github.com/pylint-dev/pylint
     rev: v3.0.2
     hooks:

diff --git a/docs/sphinx_doc/Makefile b/docs/sphinx_doc/Makefile
diff --git a/docs/sphinx_doc/assets/redirect.html b/docs/sphinx_doc/assets/redirect.html
diff --git a/docs/sphinx_doc/build_sphinx_doc.sh b/docs/sphinx_doc/build_sphinx_doc.sh
diff --git a/docs/sphinx_doc/en/source/_static/custom.css b/docs/sphinx_doc/en/source/_static/custom.css
diff --git a/docs/sphinx_doc/en/source/_templates/language_selector.html b/docs/sphinx_doc/en/source/_templates/language_selector.html
diff --git a/docs/sphinx_doc/en/source/_templates/layout.html b/docs/sphinx_doc/en/source/_templates/layout.html
diff --git a/docs/sphinx_doc/en/source/conf.py b/docs/sphinx_doc/en/source/conf.py
diff --git a/docs/sphinx_doc/en/source/index.rst b/docs/sphinx_doc/en/source/index.rst