Skip to content

Commit

Permalink
Update index_en.rst (#9321)
Browse files Browse the repository at this point in the history
* Update index_en.rst

New file

* Update index_en.rst

Fix refer to suggestions
  • Loading branch information
legend06hvl authored and abhinavarora committed Mar 26, 2018
1 parent f3dc311 commit 6a97c02
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/v2/dev/index_en.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
Development
------------


PaddlePaddle adheres to the following three sections of code and document specifications.


PaddlePaddle uses git for version control and Docker is used for building and testing environment. The code includes Cuda, C++, Python, Shell and other programming languages,which comply with Google C++ Style, Pep-8, and the code base includes style checking by an automatic inspection tool. Code comments need to follow the Doxygen specification. The code that does not meet the style requirements will fail to compile. We provide the following guidelines for the use of Git, build tests and code development.
.. toctree::
:maxdepth: 1

contribute_to_paddle_en.md


PaddlePaddle is well documented in English and Chinese. We recommend using the English version of the documents and problem description. The design documents focus on problem descriptions, backgrounds, and are followed by solutions. As documents are generated by Sphinx, code comments should comply with the Sphinx documentation standard. We recommend to use the paddlepaddle.org tool to compile and generate and preview documents locally. Please refer to:

.. toctree::
:maxdepth: 1

write_docs_en.rst

PaddlePaddle V2 defines new operations by adding new Layers. You can implement various complex layers by combining basic APIs to satisfy most applications. If you want to customize layer, please refer to the following, and welcome to propose patch.

.. toctree::
:maxdepth: 1

new_layer_en.rst

0 comments on commit 6a97c02

Please sign in to comment.