似乎有大量的 Python 文档工具。我遇到的另一个是 epydoc。似乎 Sphinx 是事实上的标准，因为它用于生成官方 Python 文档。有人可以帮我整理一下 Python 文档工具的当前状态吗？
问问题
8588 次
3 回答
26
它们的相同之处在于：
- 两者都通过docutils使用ReST。
- 两者都非常Pythonic
- 两者都可以生成 HTML 和 PDF 文档
他们的关注点不同。
- Epydoc 专注于 API（开发人员）文档。使用 Epydoc，您可以更快地获得更多结果。你把它指向你的源代码，你就会得到一些东西。这就是我想要的 API 文档工具。
- Sphinx 专注于一般（用户）文档。虽然 Sphinx 确实从您的源代码中提取了大量信息，但您需要在其中添加更多信息。Sphinx 可以生成 API 文档，但它并不直接，而且 IMO 的工作不如 Epydoc。我知道有些人会不同意，因为为Python选择了 Sphinx 。但是，这取决于您要投入多少工作。我确实喜欢 Sphinx 的一般文档。
因此，这取决于您要投入多少工作以及您要记录的内容。
于 2010-03-14T04:15:48.010 回答
4
最近从Python2换成Python3，发现没有Python3的Epydoc包。因此，对于 Python3，似乎有一个明确的重点是使用 Sphinx 作为 API 文档。
于 2014-02-06T13:06:49.150 回答
2
似乎Epydoc即使没有死，至少也渴望峡湾。
带有sphinx-apidoc命令和autodoc扩展的 Sphynx 看起来是目前 API 文档最流行的选项。
很好的例子是：
请参阅：我们应该使用 Epydoc、Sphinx 还是其他东西来记录 Python API？(SO5579198)
Sphinx 鼓励一种比 javadoc 模型中的工具更具叙述性的风格，但这也许是件好事？
于 2013-05-08T18:28:52.933 回答