QPython文档体系说明

QPython 文档体系分为 英文/中文 两部分,我们努力保持两种语言对应内容的准确和同步,其中内容其中又分为

  • 快速开始 (使用上的帮助)

  • 编程指南 (主要是用QPython来进行编程和开发的指南)

  • QPython黑客指南 (深入折腾的指导)

  • 贡献者指南 (QPython贡献者指南,分为在QPython team内的,和以外的)

如何提交文档

文档非常重要,我们用sphinx来组织文档,并且文档会通过github page功能直接推到qpython.org网站中 在想要贡献QPython文档之前仔细阅读我们的指南

  • git clone http://github.com/qpython-android/qpython

  • 进入到 项目的qpython-docs目录中

  • 按照sphinx规则编辑source中的文件即可

  • 最后cd到qpython-docs中并运行build.sh

  • 打开浏览器打开本地文件检查,

  • 如果检查无问题则可以提交,然后浏览qpython.org即可看到最新的更新

如何提交翻译

QPython是一个支持多语言的应用,你可以通过以下方式来提交对应国家的翻译