PaddlePaddle/docs

PaddlePaddle/docs

Description: Documentations for PaddlePaddle

Language: Python

License: Apache-2.0

Stars: 282

Forks: 907

Open issues: 51

Created: 2018-06-07T08:58:28Z

Pushed: 2026-06-09T09:35:04Z

Default branch: develop

Fork: no

Archived: no

README:

PaddlePaddle docs

English | [简体中文](./README_cn.md) | [日本語](./README_ja.md)

Source files for contents presented at PaddlePaddle documentation.

Note: English version API docs are generally docstrings in PaddlePaddle/Paddle, documents for other PaddlePaddle projects are being managed in their respective ways.

Codebase structure

• [docs](docs): PaddlePaddle 2.0 & above docs source file.
• [docs/api](docs/api): PaddlePaddle API docs.
• [docs/guides](docs/guides): PaddlePaddle guides docs.
• [docs/tutorial](docs/tutorial): PaddlePaddle tutorial docs.
• [ci_scripts](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.

How to contribute

PaddlePaddle welcomes documentation contributions, please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.

License

[Apache License 2.0](LICENSE)