From 17c2c763572058d43197a8af19595398bd6eee17 Mon Sep 17 00:00:00 2001 From: Daoyuan Chen <67475544+yxdyc@users.noreply.github.com> Date: Tue, 7 May 2024 16:59:05 +0800 Subject: [PATCH] Minor update the github io page, for KDD'24 tutorial placeholder (#310) * init for KDD'24 tutorial placeholder --- docs/sphinx_doc/README.md | 8 +- docs/sphinx_doc/README_ZH.md | 9 +- .../source/_static/tutorial_kdd24.html | 107 ++++++++++++++++++ docs/sphinx_doc/source/conf.py | 2 +- docs/sphinx_doc/source/index.rst | 13 ++- 5 files changed, 122 insertions(+), 17 deletions(-) create mode 100644 docs/sphinx_doc/source/_static/tutorial_kdd24.html 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/_static/tutorial_kdd24.html b/docs/sphinx_doc/source/_static/tutorial_kdd24.html new file mode 100644 index 000000000..25270d5c9 --- /dev/null +++ b/docs/sphinx_doc/source/_static/tutorial_kdd24.html @@ -0,0 +1,107 @@ + + + +
+ + + ++