使用sphinx的sphinx-apidoc实用程序从python代码自动生成文档

Question

我想知道注释格式是什么，以便使用sphinx的sphinx实用程序实现自文档化代码。我能够让这个实用程序为每个python文件生成一组reStructuredText文件，但是这些文件仍然需要填充。我正在寻找一种获取此实用程序的方法，或者一些其他Sphinx实用程序，以从python代码docstring生成文档。我理解这将需要熟悉一种传统的评论格式，我希望能指出这一参考材料。谢谢!

Answer 1

mzjn，谢谢你的评论。第二个链接提供了一些关于如何格式化docstring的很好的见解。

此外，我未能标记正确的sphinx-quickstart提示答案(如链接project/sphinx.html#full-code-example中指定的那样)。特别是，回答yes：

autodoc:从模块(y/N) n自动插入文档字符串

另外，正如链接http://codeandchaos.wordpress.com/2012/07/30/sphinx-autodoc-tutorial-for-dummies/和conf.py注释中所指出的，我需要将模块的位置附加到系统路径中。我应该注意到，我遇到了一个附加文件名的问题。当我附加可以找到模块的路径时，一切都很完美。