入门¶
Python 语言拥有大量文档，其中大部分由不同作者提供。Python 文档使用的标记语言为 reStructuredText，由 docutils 项目开发，并使用自定义指令和名为 Sphinx 的工具集对 HTML 输出进行后处理。
HTML、PDF 或 EPUB 格式的文档由使用 reStructuredText 格式 撰写的文本文件生成，这些文件包含在 CPython Git 存储库 中。
注意
如果您有兴趣为 Python 文档做出贡献，如果您不愿意，则不必编写 reStructuredText；纯文本贡献也同样受欢迎。发送电子邮件至 docs@python.org 或在 跟踪器 上提出问题。
简介¶
Python 的文档长期以来一直被认为是免费编程语言的优秀文档。造成这种情况的原因有很多，最重要的是 Python 的创建者 Guido van Rossum 早期致力于提供有关该语言及其库的文档，以及用户社区持续参与提供帮助来创建和维护文档。
社区的参与形式多样，从编写到报告错误，再到在文档可以更完整或更易于使用时进行抱怨。
本节针对 Python 文档的作者和潜在作者。更具体地说，它是针对使用与标准文档相同的工具为标准文档做出贡献并开发其他文档的人员。本指南对使用 Python 文档工具处理 Python 以外主题的作者不太有用，对根本不使用这些工具的作者来说则更无用。
如果您有兴趣为 Python 文档做出贡献，但没有时间或意愿学习 reStructuredText 和此处记录的标记结构，那么您在 Python 贡献者中也备受期待。任何时候，如果您觉得可以澄清现有文档或提供缺失的文档，现有的文档团队都将很乐意与您合作整合您的文本，为您处理标记。请不要让本节中的内容成为文档和您提供帮助的愿望之间的障碍！
构建文档¶
要构建文档，请按照以下部分中的步骤操作。您可以在构建 HTML 后通过在 Web 浏览器中打开文件 Doc/build/html/index.html 查看文档。
注意
以下说明均假定您当前的工作目录是 CPython 存储库克隆 中的 Doc 子目录。如有必要，请使用 cd Doc 切换到该目录。
创建虚拟环境¶
您可以使用以下命令创建一个具有所需依赖项的新 venv：
make venv
使用 make 构建文档将自动使用此环境，而无需您激活它。
手动创建一个新的虚拟环境。在构建文档之前，务必始终 激活此环境。
使用 make / make.bat 构建¶
提供了一个 Unix Makefile，Doc/Makefile。
提供了一个 Windows make.bat，Doc/make.bat，它尝试尽可能地模拟 Unix Makefile。
要以 HTML 格式构建文档，请运行
make html
.\make html
提示
将
html替换为htmlview，以便在构建完成后在 Web 浏览器中打开文档。将
html替换为htmllive，以便重建文档、启动本地服务器，并在对 reST 文件进行更改时自动在浏览器中重新加载页面（仅限 Unix）。
要使用 Sphinx Lint（在所有 Pull Request 中运行）检查文档中是否存在常见错误，请使用
make check
.\make check
要列出其他受支持的 make 目标，请运行
make help
.\make help
有关更多信息，请参阅 Doc/README.rst。
直接使用 Sphinx 构建¶
高级用户可能希望直接调用 Sphinx，以传递专门的选项或处理特定的用例。
确保在运行 make venv 之前激活 上面创建 的环境 已激活。然后，安装文档要求 Doc/requirements.txt。使用 pip
python -m pip install --upgrade -r requirements.txt
最后，直接使用 Sphinx 调用
python -m sphinx -b html . build/html
要使用不同的 Sphinx 构建器，请将上面的 html 替换为所需的构建器 name。