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

Question

我想知道评论格式是什么，以便使用Sphinx的sphinx-apidoc实用程序获得自我记录代码。我能够让这个实用程序为每个python文件生成一组reStructuredText文件，但是仍然需要填写这些文件。我正在寻找一种方法来获取此实用程序，或者其他一些Sphinx实用程序来生成文档。 python代码docstrings。我理解这需要熟悉传统的评论格式，我希望能够指出这个参考资料。谢谢！

Answer 1

mzjn，谢谢你的评论。您的第二个链接提供了有关如何格式化文档字符串的一些很好的见解。

此外，我没有标记正确的 sphinx-quickstart 提示答案（如链接http://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example中所述）。特别是，回答是：

autodoc：自动从模块中插入文档字符串（y / N）[n]：

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