獅身人面像，使用automodule找到子模塊

Question

當使用獅身人面像的automodule（http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule），

我只是在.rst文件中寫：

.. automodule:: my_module 
    :members: 

它證明my_module很好，但它沒有找到像my_module.inner_module0和my_module.inner_module1這樣的內部模塊。除了__all__變量之外，還有什麼需要在__init__.py文件中指定？

此外，我知道sphinx-apidoc。但是這個命令文件太多了（公開了每個功能/文件夾，包括無證文件）。

Answer 1

聽起來好像你想給automodule指令一個包名，並讓它遞歸到目錄並記錄每個Python模塊。那還不支持。您將需要指定完整的虛擬模塊名稱爲您要文檔的每個模塊。

例如，給出以下目錄結構（來自Python文檔）。您不能指定.. automodule:: sound.formats並使其記錄目錄中的所有模塊。你將不得不爲每個模塊automodule命令：.. automodule:: sound.formats.waveread，.. automodule:: sound.formats.wavewrite等

sound/       Top-level package 
     __init__.py    Initialize the sound package 
     formats/     Subpackage for file format conversions 
       __init__.py 
       wavread.py 
       wavwrite.py 
       aiffread.py 
       aiffwrite.py 
       auread.py 
       auwrite.py 
       ... 
     effects/     Subpackage for sound effects 
       __init__.py 
       echo.py 
       surround.py 
       reverse.py 
       ... 

Answer 2

在我看來，那using the :imported-members: option（非直接的聯繫，不要使用搜索）現在應該是可能的，如果__init__.py導入這些子模塊。

但是，我個人無法做到這一點（尚未）。

編輯：可能是known bug。