Skip to content

haohongxiang/docs

This branch is 1628 commits behind PaddlePaddle/docs:develop.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5bc6ced · Dec 29, 2021
Aug 26, 2020
Nov 17, 2021
Dec 29, 2021
Dec 29, 2021
Nov 11, 2019
Sep 6, 2021
Jul 30, 2021
Sep 21, 2019
Nov 13, 2020
Oct 3, 2018
Jul 8, 2021
Jul 8, 2021
Jan 21, 2021
Jul 23, 2021
Jul 8, 2021
Oct 22, 2021

Repository files navigation

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

  • doc: PaddlePaddle 1.8 & older versions docs source file, will be deleted in the future
  • 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.

How to contribute

PaddlePaddle welcomes documentation contributions, please see CONTRIBUTING.md for details.

License

Apache License 2.0

Packages

No packages published

Languages

  • Python 50.3%
  • Shell 45.4%
  • Dockerfile 4.3%