Merge pull request FederatedAI#2321 from FederatedAI/doc/deploy-readt…

…hedoc doc/deploy readthedoc
ChangxinBai · Nov 13, 2020 · a53254b · a53254b
2 parents 01ffa9f + 4d31dcb
commit a53254b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 16 deletions.
diff --git a/cluster-deploy/README.md b/cluster-deploy/README.md
@@ -42,9 +42,7 @@ This article will introduce the deployment of FATE cluster using ansible deploym
 
 Example deployment in two parties
 
-<div style="text-align:center", align=center>
-<img src="./images/arch_en.png" />
-</div>
+![](./images/arch_en.png)
 
 ## 2.Detailed Design
 
@@ -236,9 +234,7 @@ yum install -y epel-release
 
 ------
 
-<div style="text-align:center;width:500px",align=center>
-<img src="./images/deploy_cluster_en.png" />
-</div>
+![](./images/deploy_cluster_en.png)
 
 ### 4.2 System Check
 

diff --git a/cluster-deploy/doc/Fate_cluster_install_guide_ansible.md b/cluster-deploy/doc/Fate_cluster_install_guide_ansible.md
@@ -1,12 +1,14 @@
-#                     Fate cluster部署指南
+# Fate cluster部署指南
 
 # 1.总体介绍
 
 ### 1.1.系统介绍
 
 1）FATE
 
-FATE (Federated AI Technology Enabler) 是微众银行AI部门发起的开源项目，提供了一种基于数据隐私保护的安全计算框架，为机器学习、深度学习、迁移学习算法提供强有力的安全计算支持。 安全底层支持同态加密、秘密共享、哈希散列等多种多方安全计算机制，算法层支持多方安全计算模式下的逻辑回归、Boosting、联邦迁移学习等。
+FATE (Federated AI Technology Enabler) 是微众银行AI部门发起的开源项目，
+提供了一种基于数据隐私保护的安全计算框架，为机器学习、深度学习、迁移学习算法提供强有力的安全计算支持。
+安全底层支持同态加密、秘密共享、哈希散列等多种多方安全计算机制，算法层支持多方安全计算模式下的逻辑回归、Boosting、联邦迁移学习等。
 
 2）EggRoll
 
@@ -30,9 +32,7 @@ Eggroll 是一个适用于机器学习和深度学习的大规模分布式架构
 
 ### 1.3.系统架构
 
-<div style="text-align:center", align=center>
-<img src="../images/arch_zh.png" />
-</div>
+![](../images/arch_zh.png)
 
 # 2.详细设计
 
@@ -252,9 +252,7 @@ yum install -y epel-release
 
 ### 4.1 部署示意图
 
-<div style="text-align:center;width:500px",align=center>
-<img src="../images/deploy_cluster.png" />
-</div>
+![](../images/deploy_cluster.png)
 
 ### 4.2 系统检查
 

diff --git a/doc/readthedoc/conf.py b/doc/readthedoc/conf.py
@@ -45,7 +45,8 @@
     'sphinx.ext.napoleon',
     'autodocsumm',
     'recommonmark',
-    'sphinx_click.ext'
+    'sphinx_click.ext',
+    'sphinx_markdown_tables'
 ]
 
 autosummary_generate = True

diff --git a/doc/readthedoc/index.rst b/doc/readthedoc/index.rst
@@ -6,7 +6,8 @@ FATE (Federated AI Technology Enabler) is an open-source project initiated by We
 https://fate.fedai.org
 
 .. toctree::
-   :caption: Install
+   :caption: Deploy
+   :glob:
    :maxdepth: 2
 
    Standalone <_build_temp/standalone-deploy/README>

diff --git a/doc/readthedoc/requirements.txt b/doc/readthedoc/requirements.txt
@@ -4,6 +4,7 @@ sphinx_rtd_theme>=0.4.3
 autodocsumm
 recommonmark
 sphinx-click
+sphinx-markdown-tables
 
 apsw==3.9.2.post1
 beautifultable==1.0.0