帮助开发者指南

开发者指南（你现在正在阅读的内容）使用与 Python 主文档相同的流程，但有一些细微差别。源代码位于 单独的存储库 中，错误报告应提交至 devguide GitHub 跟踪器。

我们的 devguide 工作流使用持续集成和部署，因此 devguide 的更改通常在合并拉取请求时发布。对 CPython 文档的更改遵循 CPython 发布的工作流，并在发布中发布。

开发者指南工作流

若要提交 拉取请求，你可以将 devguide 存储库 分叉到你的 GitHub 帐户，并使用以下命令克隆它

$ git clone https://github.com/<your_username>/devguide

若要接受你的 PR，你还需要签署 贡献者协议。

若要构建 devguide，需要一些其他依赖项（最重要的是 Sphinx），在 Python 项目中安装依赖项的标准方法是创建一个 virtualenv，然后从 requirements.txt 文件安装依赖项。为了你的方便，这一切都已为你自动化。

若要从检出目录构建 devguide

make html

.\make html

你可以在 _build/html 中找到生成的文件。

提示

  • 在构建完成后，用 htmlview 替换 html，以便在 Web 浏览器中打开文档。

  • 用 htmllive 替换 html，以便重建文档、启动本地服务器，并在你对 reST 文件进行更改时自动在浏览器中重新加载页面（仅限 Unix）。

请注意，当你提交 拉取请求 时，make check 会自动运行。你可能希望运行 make check 和 make linkcheck，以确保它在没有错误的情况下运行。