Python docutils和斯芬克斯之间的关系是什么?

Python docutils和斯芬克斯之间的关系是什么?,python,documentation-generation,python-sphinx,epydoc,Python,Documentation Generation,Python Sphinx,Epydoc,Python的文档工具似乎太多了。我遇到的另一个是epydoc。Sphinx似乎是事实上的标准,因为它用于生成官方Python文档。有人能帮我整理一下Python文档工具的当前状态吗?它们是不同类型的工具 它们的相同之处在于: 两者都使用via 两者的重点都很像蟒蛇 两者都可以生成HTML和PDF文档 他们的重点不同 Epydoc专注于API(开发人员)文档。使用Epydoc可以更快地获得更多结果。你把它指向你的源代码,你会得到一些东西。这就是我想要的API文档工具 Sphinx专注于一般

Python的文档工具似乎太多了。我遇到的另一个是epydoc。Sphinx似乎是事实上的标准,因为它用于生成官方Python文档。有人能帮我整理一下Python文档工具的当前状态吗?

它们是不同类型的工具

它们的相同之处在于:

  • 两者都使用via
  • 两者的重点都很像蟒蛇
  • 两者都可以生成HTML和PDF文档
他们的重点不同

  • Epydoc专注于API(开发人员)文档。使用Epydoc可以更快地获得更多结果。你把它指向你的源代码,你会得到一些东西。这就是我想要的API文档工具
  • Sphinx专注于一般(用户)文档。虽然Sphinx确实从源代码中提取了大量信息,但您需要在其中添加更多信息。Sphinx可以生成API文档,但这并不是那么简单,IMO的工作也不如Epydoc好。我知道有些人会不同意,因为狮身人面像是被选中的。但是,这取决于你想投入多少精力。我非常喜欢斯芬克斯的一般文档
因此,这取决于你想投入多少工作,以及你正在记录什么。

如果没有死亡,至少对峡湾的渴望是如此

带有命令和扩展名的Sphynx看起来是目前API文档最流行的选项

很好的例子是:

  • ()
  • ()
见:


Sphinx鼓励采用比javadoc模式中的工具更具叙述性的风格,但这也许是一件好事?

我最近将Python2改为Python3,并发现Python3没有Epydoc包。因此,Python3似乎明确关注使用Sphinx作为API文档。

当前状态?这是什么意思?你能详细说明一下吗?斯芬克斯需要文件;epydoc可以使用相同的RST符号。你想知道什么?你能说得更具体些吗?例如,哪些工具有强大的社区支持、积极的开发?是否有一个现有的解决方案,或者有许多解决方案没有明显的更大的关注?也许你应该编辑这个问题的标题。感谢你解释这些工具的共同点(例如它们与文档的关系)以及它们的区别。是什么使epydoc更好地用于API文档和Sphinx更好地用于功能文档?你提到他们都使用reST。似乎有很多重叠。这只是一个方便的问题吗?此外,epydoc的开发似乎并不十分活跃。上一次提交是在2009年2月,devel列表上的最后一次通信是在2009年5月。好吧,为什么一个人在一件事上比另一件事做得更好,答案很简单,那就是他们的设计方式。Epydoc只是从代码中提取,Sphinx是从您编写的ReST文件中生成大量文档的。有很多重叠。斯芬克斯是街区里新来的孩子。我听说,在.7中,它将内置更好的自动生成功能。我非常尊重埃皮多克,但斯芬克斯现在似乎拥有所有的动力。我喜欢它,因为它看起来像python.org文档,而且我认为它看起来更好。Sphinx是一个帮助您编写完整详细文档的工具,您无法通过连接docstring来提供它。Sphinx还将支持所谓的域1.0,它将允许您记录用多种语言编写的项目,例如用Python、Javascript和C编写的webapp。我正要询问Sphinx如何生成API文档的指针,然后我找到了您的帖子<代码>sphinx.ext.autodocdoh。谢谢