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

Question

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

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注释，我需要将模块的位置附加到系统路径。我应该注意到我在附加文件名时遇到了问题。当我添加可以找到模块的路径时，一切正常。