使用Sphinx的sphinx-apidoc工具从Python代码自动生成文档

Question

使用Sphinx的sphinx-apidoc工具从Python代码自动生成文档

3

我想知道如何使用Sphinx的sphinx-apidoc工具来生成自注释代码。我已经成功使用该工具为每个Python文件生成一组reStructuredText文件，但这些文件仍需要填写。我希望找到一种方法来让该工具或其他Sphinx工具从Python代码的docstrings生成文档。我知道这需要熟悉常规的注释格式，并希望被指向相关参考资料。谢谢！

- scagnetti

你看过这些吗？http://sphinx-doc.org/domains.html?info-field-lists#info-field-lists，http://stackoverflow.com/q/4547849/407651。 - mzjn

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- scagnetti · Accepted Answer

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

此外，我没有标记正确的sphinx-quickstart提示答案（如链接中所指定http://pythonhosted.org/an_example_pypi_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注释中所述，我需要将模块的位置添加到系统路径中。我应该注意到，当我附加可以找到模块的路径时，遇到了附加文件名的问题。当我附加路径时，一切都完美地运作。