PaddlePaddle docs
English | 简体中文
Source files for contents presented at PaddlePaddle documentation.
Note: English version API docs are generaly docstrings in PaddlePaddle/Paddle, documents for other PaddlePaddle projects are being managed in their respective ways.
Codebase structure
- docs: PaddlePaddle 2.0 & above docs source file,
- docs/api: PaddlePaddle API docs
- docs/guides: PaddlePaddle guides docs
- docs/tutorial: PaddlePaddle tutorial docs
- ci_scripts: docs CI scripts
How to build
- pre-requirements
- docker
- Instructions
- step1: clone docs
git clone https://github.com/PaddlePaddle/docs - step2: build docs
cd docs mkdir output bash docs-build.sh -f absolute_path_docs - step3: preview docs The output of docs will be generated in docs/output.
- step1: clone docs
How to contribute
PaddlePaddle welcomes documentation contributions, please see CONTRIBUTING.md for details.