Doc/tutorial (#3)

DavdGao · Jan 6, 2025 · 186d99d · 186d99d
1 parent daeed21
commit 186d99d
Show file tree

Hide file tree

Showing 92 changed files with 3,085 additions and 10,800 deletions.
diff --git a/.github/workflows/sphinx_docs.yml b/.github/workflows/sphinx_docs.yml
@@ -1,10 +1,6 @@
 name: Deploy Sphinx documentation to Pages
 
 on:
-  pull_request:
-    types: [opened, synchronize]
-    paths:
-      - 'docs/**/*'
   push:
     branches:
       - main
@@ -26,25 +22,25 @@ jobs:
       uses: actions/setup-python@master
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Update setuptools
-      run: |
-        pip install setuptools==68.2.2 wheel==0.41.2
-    - name: Install Dependencies
+
+    - name: Add execute permission to build.sh
       run: |
-        pip install -q -e .[full]
+        chmod +x docs/tutorial/en/build.sh
     - id: build
       name: Build Documentation
+      env:
+        DASHSCOPE_API_KEY: ${{ secrets.DASHSCOPE_API_KEY }}
       run: |
-        cd docs/sphinx_doc
-        ./build_sphinx_doc.sh
+        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'
+        publish_dir: 'docs/tutorial/build/html'
         cname: doc.agentscope.io
diff --git a/.gitignore b/.gitignore
@@ -134,7 +134,7 @@ dmypy.json
 .DS_Store
 
 # docs
-docs/sphinx_doc/build/
+docs/tutorial/en/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