编写 Python 的文档¶

Python 包含丰富的文档, 其中的大多数都是由多位作者一起完成的. 在 Python 文档中使用的标记语言是 reStructuredText, 在 docutils 项目中开发, 增加了某些特定的指令, 并且使用一个名为 Sphinx 的工具生成 HTML.

这篇文档主要给出编写文档的样式规范, 如何使用 reStructuredText 标记语言, 以及一些在Sphinx中增加的指令, 以及如何使用Sphinx.

Note

如果你对编写python的文档感兴趣, 但不是很想用 reStructuredText, 那么用纯文本的格式会更好些. 发送邮件至 docs@python.org 或者发一个主题在 tracker.