使用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）。具体地，应答是到：

车博士：自动插入从模块文档字符串（Y/N）[N]：

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