从javadoc迁移到python文档

这个 reStructuredText 格式的设计是为了响应对可以嵌入到docstrings中的python文档的需求,所以最好是 学习REST并使用该格式格式化docstring . 你可能会发现,就像我所做的,然后你继续格式化 任何 REST中的文档,但这是一个侧重点:—)

为了专门记录您的python代码, Sphinx 系统是对REST格式的一组扩展,以及用于呈现文档的生成系统。因为它是为记录Python本身而设计的,包括标准库, sphinx允许非常好地结构化的源代码文档 当然,包括您所要求的函数签名的细节。它允许使用相同的格式系统来构建一个全面的文档套件,包括自动提取和手写。

如果你 只有 希望从源代码生成文档,然后 Epydoc 将从源代码中提取API文档 ;它也读取文本的REST格式。