|
|
|
@ -0,0 +1,65 @@
|
|
|
|
|
##################
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
|
|
|
|
|
|
mkdir paddlepaddle
|
|
|
|
|
cd paddlepaddle
|
|
|
|
|
git clone git@github.com:PaddlePaddle/Paddle.git
|
|
|
|
|
git clone git@github.com:PaddlePaddle/book.git
|
|
|
|
|
git clone git@github.com:PaddlePaddle/models.git
|
|
|
|
|
|
|
|
|
|
docker run -it -p 8000:8000 paddlepaddle/paddlepaddle.org:latest
|
|
|
|
|
|
|
|
|
|
Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation
|
|
|
|
|
|
|
|
|
|
If you don't wish to use Docker, you can also activate the tool through Django. Use the following the commands to set up
|
|
|
|
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
|
|
|
|
|
|
mkdir paddlepaddle
|
|
|
|
|
cd paddlepaddle
|
|
|
|
|
git clone git@github.com:PaddlePaddle/Paddle.git
|
|
|
|
|
git clone git@github.com:PaddlePaddle/book.git
|
|
|
|
|
git clone git@github.com:PaddlePaddle/models.git
|
|
|
|
|
git clone git@github.com:PaddlePaddle/PaddlePaddle.org.git
|
|
|
|
|
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
|
|
|
|
|
If you want to learn more on the PaddlePaddle.org, please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ 。
|
|
|
|
|
|
|
|
|
|
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 <http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html>`_ 。
|
|
|
|
|
PaddlePaddle develop branch will update the documentation once the PR is merged. User may check latest `Chinese Docs <http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html>`_ and
|
|
|
|
|
`English Docs <http://www.paddlepaddle.org/docs/develop/documentation/en/getstarted/index_en.html>`_ 。
|
|
|
|
|
|
|
|
|
|
.. _cmake: https://cmake.org/
|
|
|
|
|
.. _sphinx: http://www.sphinx-doc.org/en/1.4.8/
|