auto deploy doc on release branch, and refine doc

8 years ago · fe496f171d
parent 56b6eadd18
commit fe496f171d
10 changed files with 26 additions and 35 deletions
--- a/doc/getstarted/index_cn.rst
+++ b/doc/getstarted/index_cn.rst
@ -2,7 +2,8 @@
 ============

 ..  toctree::
-  :maxdepth: 2
+  :maxdepth: 1

  build_and_install/index_cn.rst
-  basic_usage/index_cn.rst
+
+- `深度学习入门课程 <http://book.paddlepaddle.org/>`_
--- a/doc/getstarted/index_en.rst
+++ b/doc/getstarted/index_en.rst
@ -2,7 +2,8 @@ GET STARTED
 ============

 ..  toctree::
-  :maxdepth: 2
+  :maxdepth: 1

  build_and_install/index_en.rst
-  basic_usage/index_en.rst
+
+- `Deep Learning 101 <http://book.paddlepaddle.org/index.en.html>`_
--- a/doc/howto/deep_model/rnn/hierarchical_layer_cn.rst
+++ b/doc/howto/deep_model/rnn/hierarchical_layer_cn.rst
@ -19,18 +19,18 @@

 在 PaddlePaddle中，下面这些Layer能够接受双层序列作为输入，完成相应的计算。

-pooling_layer
-==============
+pooling
+========

-pooling_layer 的使用示例如下，详细见 :ref:`api_trainer_config_helpers_layers_pooling_layer` 配置API。
+pooling 的使用示例如下，详细见 :ref:`api_v2.layer_pooling` 配置API。

 ..	code-block:: bash

-        seq_pool = pooling_layer(input=layer,
-                                 pooling_type=AvgPooling(),
-                                 agg_level=AggregateLevel.EACH_SEQUENCE)
+        seq_pool = pooling(input=layer,
+                           pooling_type=pooling.Max(),
+                           agg_level=AggregateLevel.EACH_SEQUENCE)
        
- `pooling_type` 目前支持两种，分别是：MaxPooling()和AvgPooling()。
+- `pooling_type` 目前支持两种，分别是：pooling.Max()和pooling.Avg()。

 - `agg_level=AggregateLevel.EACH_TIMESTEP` 时（默认值）：

@ -47,7 +47,7 @@ pooling_layer 的使用示例如下，详细见 :ref:`api_trainer_config_helpers
 last_seq 和 first_seq
 =====================

-last_seq 的使用示例如下（ :ref:`api_trainer_config_helpers_layers_first_seq` 类似），详细见 :ref:`api_trainer_config_helpers_layers_last_seq` 配置API。
+last_seq 的使用示例如下（ :ref:`api_v2.layer_first_seq` 类似），详细见 :ref:`api_v2.layer_last_seq` 配置API。

 ..	code-block:: bash

@ -65,16 +65,16 @@ last_seq 的使用示例如下（ :ref:`api_trainer_config_helpers_layers_first_
  - 输入：必须是一个双层序列
  - 输出：一个单层序列，其中每个元素是双层序列中每个subseq最后一个（或第一个）元素。

-expand_layer
-============
+expand
+======

-expand_layer 的使用示例如下，详细见 :ref:`api_trainer_config_helpers_layers_expand_layer` 配置API。
+expand 的使用示例如下，详细见 :ref:`api_v2.layer_expand` 配置API。

 ..	code-block:: bash

-        expand = expand_layer(input=layer1,
-                              expand_as=layer2,
-                              expand_level=ExpandLevel.FROM_TIMESTEP)
+        ex = expand(input=layer1,
+                    expand_as=layer2,
+                    expand_level=ExpandLevel.FROM_TIMESTEP)
        
 - `expand_level=ExpandLevel.FROM_TIMESTEP` 时（默认值）：

--- a/doc/howto/deep_model/rnn/index_cn.rst
+++ b/doc/howto/deep_model/rnn/index_cn.rst
@ -4,7 +4,6 @@ RNN相关模型
 ..  toctree::
  :maxdepth: 1

-  rnn_config_cn.rst
  recurrent_group_cn.md
  hierarchical_layer_cn.rst
  hrnn_rnn_api_compare_cn.rst
--- a/doc/howto/deep_model/rnn/index_en.rst
+++ b/doc/howto/deep_model/rnn/index_en.rst
@ -1,7 +1,2 @@
 RNN Models
 ==========
-
-..  toctree::
-  :maxdepth: 1
-
-  rnn_config_en.rst
--- a/doc/howto/usage/k8s/k8s_basis_cn.md
+++ b/doc/howto/usage/k8s/k8s_basis_cn.md
@ -14,7 +14,7 @@

 - [*PersistentVolume*](https://kubernetes.io/docs/user-guide/persistent-volumes/): 和[*PersistentVolumeClaim*](https://kubernetes.io/docs/user-guide/persistent-volumes/#persistentvolumeclaims)结合，将外部的存储服务在Kubernetes中描述成为统一的资源形式，便于存储资源管理和Pod引用。

-# 部署Kubernetes集群
+## 部署Kubernetes集群

 Kubernetes提供了多种集群部署的方案，本文档内不重复介绍。这里给出集中常见的部署方法：

@ -25,7 +25,7 @@ Kubernetes提供了多种集群部署的方案，本文档内不重复介绍。

 可以参考[这个表格](https://kubernetes.io/docs/getting-started-guides/#table-of-solutions)选择适合您的场景的合适方案。

-# 选择存储方案
+## 选择存储方案

 容器不会保留在运行时生成的数据，job或者应用程序在容器中运行时生成的数据会在容器销毁时消失。为了完成分布式机器学习训练任务，需要有一个外部的存储服务来保存训练所需数据和训练输出。
 常见的可选存储服务包括：
@ -35,9 +35,9 @@ Kubernetes提供了多种集群部署的方案，本文档内不重复介绍。
 - [*Ceph*](http://docs.ceph.com/docs/master/): 分布式文件系统，支持rbd，POSIX API接口(ceph fs)和对象存储API，参考[这里](https://kubernetes.io/docs/user-guide/volumes/#rbd)。
 - [*MooseFS*](https://moosefs.com/documentation.html): 一个分布式的存储系统。需要先挂载到服务器Node上再通过kubernetes hostPath Volume挂载到容器中。

-# 配置kubectl
+## 配置kubectl

-## 安装kubectl
+### 安装kubectl
 ```
 # OS X
 curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/darwin/amd64/kubectl
@ -49,7 +49,7 @@ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s htt
 curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/windows/amd64/kubectl.exe
 ```

-## 配置kubectl访问你的kubernetes集群
+### 配置kubectl访问你的kubernetes集群

 编辑`~/.kube/config`这个配置文件，修改`Master-IP`的地址。如果使用SSL认证，则需要配置`certificate-authority`和`users`中的用户证书。如果是使用非SSL方式访问（比如通过8080端口），也可以去掉这些证书的配置。
 ```
--- a/doc/index_cn.rst
+++ b/doc/index_cn.rst
@ -5,7 +5,6 @@ PaddlePaddle 文档
  :maxdepth: 1

  getstarted/index_cn.rst
-  tutorials/index_cn.md
  howto/index_cn.rst
  api/index_cn.rst
  faq/index_cn.rst
--- a/doc/index_en.rst
+++ b/doc/index_en.rst
@ -5,8 +5,6 @@ PaddlePaddle Documentation
  :maxdepth: 1

  getstarted/index_en.rst
-  tutorials/index_en.md
  howto/index_en.rst
  api/index_en.rst
  about/index_en.rst
- 
--- a/doc_theme/templates/layout.html
+++ b/doc_theme/templates/layout.html
@ -115,9 +115,6 @@
        </div>
        <ul class="site-page-links">
          <li><a href="/">Home</a></li>
-          <li><a href="http://book.paddlepaddle.org">Get Started</a></li>
-          <li class="active"><a>Documentation</a></li>
-	  <!-- <li><a>About Us</a></li> -->
        </ul>
      </div>
      <div class="doc-module">
--- a/paddle/scripts/travis/docs.sh
+++ b/paddle/scripts/travis/docs.sh
@ -60,6 +60,7 @@ function deploy_docs() {

 deploy_docs "master" "." 
 deploy_docs "develop" "./develop/"
+deploy_docs "release/0.10.0" "./release/0.10.0/"

 # Check is there anything changed.
 set +e