Browse Source

[Feature][document]add quickstart,install docs description

AllDataDC 1 year ago
parent
commit
981a0e8b6c
4 changed files with 5 additions and 5 deletions
  1. 1 1
      README.md
  2. 2 2
      document/README.md
  3. 1 1
      document/source/README.md
  4. 1 1
      document/source/conf.py

+ 1 - 1
README.md

@@ -1,6 +1,6 @@
 # 可定义数据中台
 
-## [官方文档](https://alldata.readthedocs.io/) | [安装文档](https://github.com/alldatacenter/alldata/blob/master/install.md) | [Community](#community)
+## [官方文档](https://alldata.readthedocs.io/) | [安装文档](https://github.com/alldatacenter/alldata/blob/master/install.md)
 
 ## 安装教程
 > https://github.com/alldatacenter/alldata/blob/master/install.md

+ 2 - 2
document/README.md

@@ -8,7 +8,7 @@
 ```markdown
 pip3 install sphinx-autobuild
 pip3 install sphinx_rtd_theme
-pip3 install recommonmark
+pip3 install --upgrade myst-parser
 pip3 install sphinx_markdown_tables
 ```
 > 3 配置mac(mac单独配置)
@@ -24,7 +24,7 @@ source ~/.bash_profile
 > 
 > 7 python3.10 -m pip install --upgrade pip
 > 
-> 8 pip3 install recommonmark && pip3 install sphinxawesome_theme
+> 8  pip3 install --upgrade myst-parser && pip3 install sphinxawesome_theme
 > 
 > 9 make html
 > 

+ 1 - 1
document/source/README.md

@@ -1,6 +1,6 @@
 # 可定义数据中台
 
-## [官方文档](https://alldata.readthedocs.io/) | [安装文档](https://github.com/alldatacenter/alldata/blob/master/install.md) | [Community](#community)
+## [官方文档](https://alldata.readthedocs.io/) | [安装文档](https://github.com/alldatacenter/alldata/blob/master/install.md)
 
 ## 安装教程
 > https://github.com/alldatacenter/alldata/blob/master/install.md

+ 1 - 1
document/source/conf.py

@@ -14,7 +14,7 @@ release = '0.4.x'
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['recommonmark']
+extensions = ['myst_parser']
 
 templates_path = ['_templates']
 exclude_patterns = []