使用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評論，我需要將模塊的位置追加到系統路徑。我應該注意到，我遇到了追加文件名的問題。當我追加模塊可以找到的路徑時，一切工作完美。