Trong trình tạo tài liệu Sphinx, tôi có thể thêm toàn bộ gói (đệ quy) vào Chỉ mục không?

Question

Tôi muốn tạo tài liệu cho gói của mình. Mỗi tệp trong dự án đều chứa tài liệu mở rộng. Có cách nào để nhanh chóng thêm toàn bộ dự án của tôi vào chỉ mục documetation không?

Tôi muốn tự động tạo một số tài liệu cho toàn bộ dự án với ít nhất là công việc có thể. Tôi bắt đầu bằng cách thêm dòng sau vào index.rst:

.. automodule:: mymodulename 
    :members: 

Tất cả những gì dường như đã làm là elenments tài liệu trong __init__.py file (chỉ là một docstring) - là có cách nào tôi có thể làm cho nó ghi lại mọi thứ khác? Tôi đang tìm cách để thêm hoàn toàn tất cả mọi thứ được định nghĩa trong gói của tôi và có tất cả các lớp duy nhất, hằng số, chức năng (vv) trong gói được thêm vào chỉ mục thích hợp.

Việc này có thể thực hiện được không?

Answer 1

Bạn có thể sử dụng sphinx-apidoc.
Từ official documentation: sphinx-apidoc là công cụ để tự động tạo nguồn Sphinx, sử dụng phần mở rộng autodoc, ghi lại toàn bộ gói theo phong cách của các công cụ tài liệu API tự động khác.

Một ví dụ sử dụng có thể là (từ thư mục gốc của dự án của bạn):

$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0' 

Một thư mục doc sẽ được tạo ra với tất cả mọi thứ đã sẵn sàng ở bên trong.
Bạn cũng có thể điều chỉnh cài đặt của tài liệu của bạn chỉnh sửa tệp conf.py được tạo tự động.

Thông tin hữu ích khác có thể được tìm thấy trong similar question posted here.