Hãy đọc Tài liệu bao gồm tài liệu tự động cho các thành viên đặc biệt?

Question

Tôi có một mô-đun với hai thành viên đặc biệt toàn cầu được ghi lại.

Chạy Nhân sư tại địa phương tạo tài liệu bao gồm tài liệu của họ nhưng Đọc tài liệu thì không. Nó sử dụng tài liệu kiểu built-in thay vào đó.

Tôi đã thử cả hai kiểu: #: và docstring sau định nghĩa. Tôi đã đọc tài liệu của autodoc nhiều lần và Read the Docs entry on it. Tôi không thể tìm ra những gì tôi đang thiếu, vì tôi thậm chí không thấy bất kỳ lỗi xây dựng nào trên Đọc tài liệu.

Bất kỳ ý tưởng nào?

Answer 1

Trong trường hợp bạn đang sử dụng phần mở rộng Napoleon để xử lý NumPy hoặc Google docstrings phong cách, bạn có thể đặt một lá cờ cấu hình cho điều này trong conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

bạn Nếu tôi nhớ không lầm đó cũng là một chỉ thị cho autodoc:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

Bằng cách thực hiện phương pháp này, bạn có thể lựa chọn hạt mịn trong đó thành viên sẽ được bao gồm trong các tài liệu và đó không phải là.