如何從我的Python模塊中使sphinx-quickstart自動包含docstrings

Question

我正在嘗試Sphinx為Python項目生成文檔。 為了確保我可以真正使用它，我已經做了一個測試項目來嘗試一下： https : //github.com/ThomasA/sphinxtest 。

我已經在此存儲庫的根目錄中運行了sphinx-quickstart 。 在以下問題中，我將“ doc”指定為文檔根目錄，名為項目“ sphinxtest”，輸入“ Thomas Arildsen”作為作者，對“ autodoc”選項回答“ y”，並為其他所有設置選擇默認設置。

我希望'autodoc'選項會導致在'doc'文件夾中生成文件'amodule.rst'。 但是，這不會生成。 我對此感到困惑。 我認為這就是“ autodoc”選項應該做的事情，而我看到的其他例子顯然也可以用它實現。 Sphinx完成時沒有任何錯誤消息，因此它似乎正在執行它認為應該執行的操作。 那么，我可能做錯了什么？

我正在使用均隨Anaconda安裝的Sphinx 1.5.6和Python 3.5.3。

Answer 1

autodoc不會生成.rst源文件。

相反，首先使用sphinx-apidoc生成源文件。 然后運行Sphinx制作文檔。

Answer 2

Percy的答案的替代方法是Carlos Jenkins編寫的autoapi 。 他提供了一個Sphinx擴展名，該擴展名可在每次文檔生成時生成ReST文件。 您可以通過修改模板文件來配置輸出ReST。

https://github.com/carlos-jenkins/autoapi