提交 2f41aaa4 编写于 作者: L Luo Tao

adjust the structure of documentation

上级 f2154002
...@@ -13,7 +13,7 @@ PaddlePaddle提供pip和Docker的安装方式: ...@@ -13,7 +13,7 @@ PaddlePaddle提供pip和Docker的安装方式:
pip_install_cn.rst pip_install_cn.rst
docker_install_cn.rst docker_install_cn.rst
../../howto/dev/build_cn.md build_cn.md
编译流程 编译流程
++++++++ ++++++++
......
...@@ -13,7 +13,7 @@ You can choose either pip or Docker to complete your install: ...@@ -13,7 +13,7 @@ You can choose either pip or Docker to complete your install:
pip_install_en.rst pip_install_en.rst
docker_install_en.rst docker_install_en.rst
../../howto/dev/build_en.md build_en.md
Build from Source Build from Source
......
../../CONTRIBUTING.md
\ No newline at end of file
开发标准
========
.. toctree::
:maxdepth: 1
contribute_to_paddle_cn.md
write_docs_cn.rst
Development
------------
.. toctree::
:maxdepth: 1
new_layer_en.rst
contribute_to_paddle_en.md
write_docs_en.rst
################## #############
如何贡献/修改文档 如何贡献文档
################## #############
PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。 PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
也可以利用PaddlePaddle 工具来编译文档,这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下 也可以利用PaddlePaddle 工具来编译文档,这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下
......
################## ########################
Contribute Documentation Contribute Documentation
################## ########################
PaddlePaddle supports English documentation ``doc`` and Chinese documentation ``doc_cn``. PaddlePaddle supports English documentation ``doc`` and Chinese documentation ``doc_cn``.
Both are compiled by `cmake`_ and `sphinx`_ , the compiled documentations will be stored under ``doc`` and ``doc_cn`` directories. Both are compiled by `cmake`_ and `sphinx`_ , the compiled documentations will be stored under ``doc`` and ``doc_cn`` directories.
......
## 编译 PaddlePaddle 预测库 ## 安装与编译C-API预测库
### 概述 ### 概述
......
PaddlePaddle C-API C-API预测库
================== ==================
.. toctree:: .. toctree::
......
## C-API 使用流程 ## C-API使用流程
这篇文档介绍 PaddlePaddle C-API 整体使用流程。 这篇文档介绍 PaddlePaddle C-API 整体使用流程。
......
.. _cmd_line_index: .. _cmd_line_index:
设置命令行参数 命令行参数设置
=============== ===============
.. toctree:: .. toctree::
......
../../../CONTRIBUTING.md
\ No newline at end of file
进阶指南 进阶指南
======== ========
使用说明
--------
.. toctree::
:maxdepth: 1
usage/cmd_parameter/index_cn.rst
usage/cluster/cluster_train_cn.md
usage/capi/index_cn.rst
开发标准
--------
.. toctree::
:maxdepth: 1
dev/contribute_to_paddle_cn.md
dev/write_docs_cn.rst
模型配置
--------
.. toctree::
:maxdepth: 1
deep_model/rnn/index_cn.rst
性能优化
--------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
cmd_parameter/index_cn.rst
cluster/cluster_train_cn.md
capi/index_cn.rst
rnn/index_cn.rst
optimization/gpu_profiling_cn.rst optimization/gpu_profiling_cn.rst
HOW TO HOW TO
======= =======
Usage
-------
.. toctree::
:maxdepth: 1
usage/cmd_parameter/index_en.rst
usage/cluster/cluster_train_en.md
Development
------------
.. toctree::
:maxdepth: 1
dev/new_layer_en.rst
dev/contribute_to_paddle_en.md
dev/write_docs_en.rst
Configuration
-------------
.. toctree::
:maxdepth: 1
deep_model/rnn/index_en.rst
Optimization
-------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
cmd_parameter/index_en.rst
cluster/cluster_train_en.md
rnn/index_en.rst
optimization/gpu_profiling_en.rst optimization/gpu_profiling_en.rst
================== ============
GPU性能分析与调优 GPU性能调优
================== ============
.. contents:: .. contents::
......
...@@ -5,6 +5,8 @@ PaddlePaddle 文档 ...@@ -5,6 +5,8 @@ PaddlePaddle 文档
:maxdepth: 1 :maxdepth: 1
getstarted/index_cn.rst getstarted/index_cn.rst
build_and_install/index_cn.rst
howto/index_cn.rst howto/index_cn.rst
dev/index_cn.rst
api/index_cn.rst api/index_cn.rst
faq/index_cn.rst faq/index_cn.rst
...@@ -5,5 +5,7 @@ PaddlePaddle Documentation ...@@ -5,5 +5,7 @@ PaddlePaddle Documentation
:maxdepth: 1 :maxdepth: 1
getstarted/index_en.rst getstarted/index_en.rst
build_and_install/index_en.rst
howto/index_en.rst howto/index_en.rst
dev/index_en.rst
api/index_en.rst api/index_en.rst
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册