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

问题描述 投票:4回答:1

我想知道为了使用Sphinx的apidoc实用程序来实现自我文档化的代码,注释的格式是什么。 我可以让这个工具为每个python文件生成一组reStructuredText文件,但是这些文件仍然需要填写。 我正在寻找一种方法来让这个实用程序或其他Sphinx实用程序从python代码的docstrings中生成文档。 我知道这需要熟悉传统的注释格式,我希望能得到这个参考材料。 谢谢!我想知道注释格式是什么?

python python-sphinx sphinx-apidoc
1个回答
1
投票

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

此外,我没有标记适当的 sphinx-快速启动 提示答案(按链接中的规定。http:/pythonhosted.organ_example_pypi_projectsphinx.html#full-code-example。特别是,回答 是的 到。

autodoc:自动从模块中插入docstrings (yN) [n]。

也是,如链接中所述。http:/codeandchaos.wordpress.com20120730sphinx-autodoc-tutorial-for-dummies。我需要在系统路径中添加模块的位置。 注释,我需要将模块的位置附加到系统路径上。我应该注意的是,我遇到了一个附加文件名的问题,当我附加了可以找到模块的路径时,一切都很完美。

© www.soinside.com 2019 - 2024. All rights reserved.