+
+ +
+

Contribute Documentation

+

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. +When using the PaddlePaddle.org to compile documentations, the compiled documentations will be stored under a consolidated directory: .ppo_workspace/content

+
+

How to Build Documentations

+

We recommend using PaddlePaddle.org tool to build documentation

+
+

Use PaddlePaddle.org tool

+

This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.

+

The tool uses Docker, please install it on your system. Please check Docker official website on how to install Docker. You may use the following commands to activate the tool

+
mkdir paddlepaddle # Create paddlepaddle working directory
+cd paddlepaddle
+
+# Clone the content repositories. You may only clone the contents you need
+git clone https://github.com/PaddlePaddle/Paddle.git
+git clone https://github.com/PaddlePaddle/book.git
+git clone https://github.com/PaddlePaddle/models.git
+git clone https://github.com/PaddlePaddle/Mobile.git
+
+# Please specify the working directory through -v
+docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest
+
+
+

Note: PaddlePaddle.org will read the content repos specified in the -v (volume) flag of the docker run command +Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation +The compiled documentations will be stored in <paddlepaddle working directory>/.ppo_workspace/content

+

If you don’t wish to use Docker, you can also activate the tool through Django. Use the following the commands to set up

+
mkdir paddlepaddle # Create paddlepaddle working directory
+cd paddlepaddle
+
+# Clone the content repositories and PaddlePaddle.org
+git clone https://github.com/PaddlePaddle/Paddle.git
+git clone https://github.com/PaddlePaddle/book.git
+git clone https://github.com/PaddlePaddle/models.git
+git clone https://github.com/PaddlePaddle/Mobile.git
+git clone https://github.com/PaddlePaddle/PaddlePaddle.org.git
+
+# Please specify the PaddlePaddle working directory. In the current setting, it should be pwd
+export CONTENT_DIR=<path_to_paddlepaddle_working_directory>
+export ENV=''
+cd PaddlePaddle.org/portal/
+pip install -r requirements.txt
+python manage.py runserver
+
+
+

Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation +The compiled documentations will be stored in <paddlepaddle working directory>/.ppo_workspace/content

+

If you want to learn more on the PaddlePaddle.org, please click here 。

+
+
+
+

How to write Documentations

+

PaddlePaddle uses sphinx to compile documentations，Please check sphinx official website for more detail.

+
+
+

How to update www.paddlepaddle.org

+

Please create PRs and submit them to github, please check Contribute Code 。 +PaddlePaddle develop branch will update the documentation once the PR is merged. User may check latest Chinese Docs and +English Docs 。

+
+
+ + +
+