diff --git a/docs/sphinx_doc/README.md b/docs/sphinx_doc/README.md index 43127bbeb..395e6ac41 100644 --- a/docs/sphinx_doc/README.md +++ b/docs/sphinx_doc/README.md @@ -17,10 +17,4 @@ pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark mv build/html position_to_publish ``` -- For convenience (you don’t have to compile from scratch again), the built - directory (including the html files) can be download as follows: -```bash -# cd docs/sphinx_doc -wget https://dail-wlcb.oss-cn-wulanchabu.aliyuncs.com/data_juicer/sphinx_API_build_0801.zip -unzip sphinx_API_build_0801.zip -``` +Automatic action in github can be found in [here](https://github.com/modelscope/data-juicer/blob/main/.github/workflows/deploy_sphinx_docs.yml). \ No newline at end of file diff --git a/docs/sphinx_doc/README_ZH.md b/docs/sphinx_doc/README_ZH.md index e02179532..960d18b6d 100644 --- a/docs/sphinx_doc/README_ZH.md +++ b/docs/sphinx_doc/README_ZH.md @@ -15,10 +15,5 @@ pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark mv build/html position_to_publish ``` -- 为了方便起见(不必再次从头开始编译),可以按如下方式下载构建的目录(包括 html 文件): - -```bash -# cd docs/sphinx_doc -wget https://dail-wlcb.oss-cn-wulanchabu.aliyuncs.com/data_juicer/sphinx_API_build_0801.zip -unzip sphinx_API_build_0801.zip -``` +Github上的自动化部署配置可参考 [该处]( +https://github.com/modelscope/data-juicer/blob/main/.github/workflows/deploy_sphinx_docs.yml). \ No newline at end of file diff --git a/docs/sphinx_doc/source/index.rst b/docs/sphinx_doc/source/index.rst index 883a2f548..27fed339f 100644 --- a/docs/sphinx_doc/source/index.rst +++ b/docs/sphinx_doc/source/index.rst @@ -6,14 +6,19 @@ Welcome to data-juicer's documentation! ======================================= -We will give a tutorial on KDD'24, Multi-modal Data Processing for Foundation Models: Practical Guidances and Use Cases, see more details ` here <../_static/my_standalone.html>`_ ! +Tutorial +--------------------------------------- + +We will give a tutorial on KDD'24, Multi-modal Data Processing for Foundation Models: Practical Guidances and Use Cases, see more details `here <_static/tutorial_kdd24.html>`_! + + .. toctree:: :maxdepth: 2 :glob: - :caption: Data-Juicer API Reference + :caption: API Reference data_juicer.core data_juicer.ops @@ -26,7 +31,7 @@ We will give a tutorial on KDD'24, Multi-modal Data Processing for Foundation Mo data_juicer.config data_juicer.format -Indices and tables +Indices and Tables ================== * :ref:`genindex`