1
我正在嘗試使用Sphinx生成Python項目的文檔。爲了確保我能夠真正做到這一點，我做了一個測試項目來試用：https://github.com/ThomasA/sphinxtest。我如何使我的Python模塊中的sphinx-quickstart自動包含文檔字符串
我在此存儲庫的根目錄中運行了sphinx-quickstart。在下面的問題中，我將'doc'指定爲文檔根目錄，命名爲項目'sphinxtest'，輸入作者爲'Thomas Arildsen'，對'autodoc'選項回答'y'，並選擇默認設置。
我預計'autodoc'選項會導致在'doc'文件夾中產生文件'amodule.rst'。但是，這不會生成。我對此感到困惑。我認爲這是'autodoc'選項應該做的事情，以及我見過的其他例子顯然可以實現它。獅身人面像完成沒有任何錯誤信息，所以它似乎在做它認爲應該做的事情。那麼，我會做什麼錯？
我使用Sphinx v。1.5.6和Python 3.5.3，所有都安裝了Anaconda。
大，但我還是有點困惑：'獅身人面像，apidoc -o DOC .'產生 'DOC/sphinxtest.rst' 和 '文檔/ modules.rst'。根據我在別人的項目中看到的，我也預計會有'amodules.rst'。 –
我似乎已經明白了;我沒有意識到，我必須編輯conf.py來添加一個路徑才能找到該模塊並編輯index.rst，以便將其實際包含在文檔中。 –