Skip to content

Commit

Permalink
init for KDD'24 tutorial placeholder
Browse files Browse the repository at this point in the history
  • Loading branch information
yxdyc committed May 7, 2024
1 parent 050564d commit 8497d89
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 17 deletions.
8 changes: 1 addition & 7 deletions docs/sphinx_doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
9 changes: 2 additions & 7 deletions docs/sphinx_doc/README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
11 changes: 8 additions & 3 deletions docs/sphinx_doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
Expand Down

0 comments on commit 8497d89

Please sign in to comment.