AllDataFounder 05049d6777 [Feature][document]modify docs,update README.md		1 year ago
..
source	05049d6777 [Feature][document]modify docs,update README.md	1 year ago
.gitkeep	7d86b44ecf feature(alldatadc): 引入readthedocs添加AllData官方文档	2 years ago
.readthedocs.yaml	7536bec231 Update .readthedocs.yaml	1 year ago
Makefile	7d86b44ecf feature(alldatadc): 引入readthedocs添加AllData官方文档	2 years ago
README.md	981a0e8b6c [Feature][document]add quickstart,install docs description	1 year ago
make.bat	22bb022fe0 [Feature][artic,lakesoul,fsl]init artic,lakesoul,flink-sql-lineage	2 years ago

Document For AllData

build document

1 pip3 install -U Sphinx

2 install dependency
pip3 install sphinx-autobuild
pip3 install sphinx_rtd_theme
pip3 install --upgrade myst-parser
pip3 install sphinx_markdown_tables
3 配置mac(mac单独配置)
echo 'export HOMEBREW_BOTTLE_DOMAIN=https://mirrors.tuna.tsinghua.edu.cn/homebrew-bottles' >> ~/.bash_profile
source ~/.bash_profile
4 brew install sphinx-doc

5 echo 'export PATH="/opt/homebrew/opt/sphinx-doc/libexec/bin:$PATH"' >> ~/.zshrc

6 sphinx-build --version 查看version

7 python3.10 -m pip install --upgrade pip

8 pip3 install --upgrade myst-parser && pip3 install sphinxawesome_theme

9 make html

10 双击访问本地alldata/document/build/html/index.html

README.md

Document For AllData

build document