獅身人面像定製autoclass輸出

Question

我有一個模塊與幾個類。目前我正在使用..automodule來記錄模塊。我希望每個類都有自己的頭部分和類名。我可以用替換..automodule foo實現這一目標：

Bar 
=== 

..autoclass foo.Bar 

Baz 
=== 

..autoclass foo.Baz 

... 

然而，這需要我手動列出每個班級每個模塊爲我做到這一點英寸自定義由automodule生成的內容的最佳方式是什麼？

Answer 1

Sphinx不像Epydoc或Doxygen那樣直接用於從源代碼生成API文檔。它是一種不同類型的工具。

獅身人面像適用於.rst（reStructuredText）文件，如果您希望每個類都有自己的類名稱，您必須自己添加標題並使用.. autoclass::。只有.. automodule::才能完成。是的，這很不方便（類似的情緒表示爲here）。另見this answer和this answer。

該問題可以通過遍歷Python代碼並生成.rst輸出的腳本來緩解。獅身人面像已經有了這樣一個腳本，sphinx-apidoc。但是，它不會生成任何.. autoclass::指令，只有.. automodule::。

這是另一個腳本，可以輸出.. autoclass::：https://github.com/PyMVPA/PyMVPA/blob/master/tools/apigen.py。也許你可以使用它。