Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.32 KB

README_cn.md

File metadata and controls

42 lines (31 loc) · 1.32 KB

PaddlePaddle docs

English | 简体中文

docs 是 PaddlePaddle 官网文档 的源文件。

注意:英文版API文档直接从PaddlePaddle/Paddle 的 docstring 中生成,飞桨其他项目的文档分别在其对应的位置中管理。

仓库结构

  • doc: 飞桨框架 1.8 以及更老版本文档的源文件,会在未来删除。
  • docs: 飞桨框架 2.0 以及之后版本文档的源文件。
  • docs/api: 飞桨中文 API文档的源文件。
  • docs/guides: 飞桨官方教程的源文件。
  • docs/tutorial: 飞桨相关案例的源文件。
  • ci_scripts: docs CI 相关的文件。

如何构建文档

  • 依赖
    • docker
  • 构建过程
    • 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 输出的文件会保存在 docs/output 路径下.

贡献

我们非常欢迎你贡献文档!你可以参考 贡献指南 直接参与。

License

Apache License 2.0