update readme for sphinx doc

modelscope · Apr 17, 2024 · e45c72c · e45c72c
1 parent f444235
commit e45c72c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 20 deletions.
diff --git a/.github/workflows/deploy_spinx_docs.yml b/.github/workflows/deploy_spinx_docs.yml
@@ -32,7 +32,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: SphinxDoc
-        path: 'docs/sphinx_doc/build'
+        path: 'docs/sphinx_doc/build/html'
     - uses: peaceiris/actions-gh-pages@v3
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
       with:

diff --git a/docs/sphinx_doc/README.md b/docs/sphinx_doc/README.md
@@ -9,17 +9,11 @@ doc, please run the following commands:
 # 1. install the sphinx requirements and init the sphinx-quickstart
 pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark
 # or pip install -r ../../environments/dev_requires
-sphinx-quickstart
 
-# 2. auto generate the doc files for all sub modules (*.rst) from source codes
-sphinx-apidoc -o source ../../data_juicer
+# 2. auto generate and build the doc
+./build_doc.sh
 
-# 3. modify the auto-generated files according to your requirements
-vim source/modules.rst
-
-# 4. finalize the doc, which is stored in the `build/html` directory
-make clean
-make html
+# 3. finalize the doc, which is stored in the `build/html` directory
 mv build/html position_to_publish
 ```
 

diff --git a/docs/sphinx_doc/README_ZH.md b/docs/sphinx_doc/README_ZH.md
@@ -8,17 +8,10 @@ Data-Juicer 借助 Sphinx 构建 API 文档。
 # 1.安装 sphinx 的依赖并初始化 sphinx-quickstart
 pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark
 # or pip install -r ../../environments/dev_requires
-sphinx-quickstart
+# 2. 运行文档构建脚本
+./build_doc.sh
 
-# 2. 从源代码自动生成所有子模块（*.rst）的文档文件
-sphinx-apidoc -o source ../../data_juicer
-
-# 3. 根据您的要求修改自动生成的文件
-vim source/modules.rst
-
-# 4. 完成文档的构建，文档存储目录为 `build/html`
-make clean
-make html
+# 3. 构建完成的文档存储目录为 `build/html`
 mv build/html position_to_publish
 ```