python - docutils 和 Sphinx 是什么关系？

Question

似乎有大量的 Python 文档工具。我遇到的另一个是 epydoc。似乎 Sphinx 是事实上的标准，因为它用于生成官方 Python 文档。有人可以帮我整理一下 Python 文档工具的当前状态吗？

Answer 1

epydoc和 Sphinx是不同类型的工具。

它们的相同之处在于:

• 两者都使用 ReST通过 docutils .
• 两者都非常注重 Python 风格
• 两者都可以生成 HTML 和 PDF 文档

他们的关注点不同。

• Epydoc 专注于 API(开发人员)文档。使用 Epydoc，您可以更快地获得更多结果。你把它指向你的源代码，你就会得到一些东西。这就是我想要的 API 文档工具。
• Sphinx 专注于一般(用户)文档。虽然 Sphinx 确实从您的源代码中提取了大量信息，但您需要在其中添加更多信息。 Sphinx 可以生成 API 文档，但它并不直接，而且 IMO 的工作不如 Epydoc。我知道有些人会不同意，因为 Sphinx 被选为 Python .但是，这取决于您要投入多少工作。我很喜欢 Sphinx 的一般文档。

所以这取决于您要投入多少工作以及您要记录的内容。