modify doc

wickai · Dec 15, 2021 · d132202 · d132202
1 parent 3f671a9
commit d132202
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/docs/zh_CN/introduction/index.rst b/docs/zh_CN/introduction/index.rst
@@ -4,8 +4,5 @@
 .. toctree::
  :maxdepth: 2
 
- product.md
- logo.md
- cartoon.md
- more_demo.md
- vehicle.md
+ function_intro.md
+ more_demo/index
diff --git a/docs/zh_CN/introduction/more_demo/index.rst b/docs/zh_CN/introduction/more_demo/index.rst
@@ -0,0 +1,12 @@
+介绍
+================================
+
+.. toctree::
+ :maxdepth: 2
+
+ cartoon.md
+ logo.md
+ more_demo.md
+ product.md
+ vehicle.md
+
diff --git a/readthedoc指南.md b/readthedoc指南.md
@@ -26,12 +26,13 @@
  html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
  ```
 
- 5.2 添加markdown支持
+ 5.2 添加markdown支持和markdown表格支持
 
- 首先需要安装recommonmark
+ 首先需要安装recommonmark和sphinx_markdown_tables
 
  ```shell
  pip install recommonmark
+ pip install sphinx_markdown_tables
  ```
 
  在source/conf.py中更改或添加如下代码
@@ -42,6 +43,10 @@
  '.md': CommonMarkParser,
  }
  source_suffix = ['.rst', '.md']
+ extensions = [
+ 'recommonmark',
+ 'sphinx_markdown_tables'
+ ]
  ```
 
  以上五步具体效果可以参考https://www.jianshu.com/p/d1d59d0cd58c