Sphinx, sử dụng automodule để tìm submodules

Question

Khi sử dụng automodule nhân sư của (http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule),

tôi chỉ đơn giản viết trong một tập tin .rst:

.. automodule:: my_module 
    :members: 

Tài liệu my_module tốt, nhưng không tìm thấy mô đun bên trong như my_module.inner_module0 và my_module.inner_module1. Có điều gì cần được chỉ định trong tệp __init__.py bên cạnh biến __all__ không?

Ngoài ra, tôi biết về sphinx-apidoc. Nhưng lệnh đó tài liệu quá nhiều (cho thấy mọi chức năng/thư mục bao gồm cả những tài liệu không có giấy tờ).

Answer 1

Có vẻ như bạn muốn cung cấp cho chỉ thị automodule tên gói và yêu cầu nó tái nhập vào thư mục và ghi lại từng mô-đun Python. Chưa được hỗ trợ. Bạn sẽ phải chỉ định đầy đủ tên mô-đun chấm chấm cho từng mô-đun bạn muốn ghi tài liệu.

Ví dụ: được cung cấp cấu trúc thư mục sau (từ tài liệu Python). Bạn không thể chỉ định .. automodule:: sound.formats và có tài liệu tất cả các mô-đun trong thư mục. Bạn sẽ phải chỉ định một lệnh automodule cho mỗi mô-đun: .. automodule:: sound.formats.waveread, .. automodule:: sound.formats.wavewrite vv

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

Dường như với tôi rằng using the :imported-members: option (liên kết không trực tiếp, đừng sử dụng tìm kiếm), nên có thể, nếu __init__.py nhập khẩu những submodules.

Tuy nhiên, cá nhân tôi không thể thực hiện công việc này (chưa).

CHỈNH SỬA: Có thể là known bug.