docutils和Sphinx之间有什么关系？

Question

似乎有太多的Python文档工具.我碰到的另一个是epydoc.似乎Sphinx是事实上的标准,因为它用于生成官方Python文档.有人可以帮我理清Python文档工具的当前状态吗？

Answer 1

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

它们是相同的:

他们的焦点不同.

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

因此,这取决于您想要投入多少工作以及您要记录的内容.

Sphinx并不专注于一般用户文档.Sphinx是一个工具,可以帮助您编写完整而详细的文档,您无法通过连接文档字符串来提供这些文档.此外,Sphinx将支持所谓的1.0域,它允许您记录用多种语言编写的项目,例如用Python,Javascript和C编写的webapp. (3认同)
好吧,为什么一个人在另一件事情上更好的答案就是他们的设计方式.Epydoc只需从代码中提取,Sphinx就可以从你编写的ReST文件中生成很多文档.有很多重叠.狮身人面像是这个街区的新生儿.我听说有传闻说在.7中内置了更好的自动生成功能.我对Epydoc非常尊重,但是Sphinx似乎现在拥有了所有的动力.我喜欢它,因为它看起来像python.org文档,我认为它看起来更好. (2认同)