Câu hỏi được gắn thẻ «autodoc»

Tôi đang cố gắng sử dụng Sphinx để ghi lại dự án hơn 5.000 dòng trong Python. Nó có khoảng 7 mô-đun cơ sở. Theo như tôi biết, để sử dụng autodoc, tôi cần viết mã như thế này cho mỗi tệp trong dự án của mình: .. automodule:: mods.set.tests …

149 python  python-sphinx  autodoc 

Sphinx không tạo tài liệu cho __init __ (self) theo mặc định. Tôi đã thử những cách sau: .. automodule:: mymodule :members: và ..autoclass:: MyClass :members: Trong conf.py, cài đặt sau chỉ nối chuỗi doc_init __ (self) vào chuỗi docstring của lớp ( tài liệu tự động mã Sphinx dường …

107 python  python-sphinx  autodoc 

Tôi đang cố gắng bắt đầu với Sphinx và dường như gặp phải những vấn đề không ngừng. Chỉ huy: docs/sphinx-quickstart Tôi trả lời tất cả các câu hỏi và mọi thứ hoạt động tốt. Chỉ huy: docs/ls Mọi thứ trông bình thường. Kết quả:build Makefile source Chỉ huy: sphinx-build …

104 python  python-sphinx  autodoc 

Tôi đang sử dụng sphinx và plugin autodoc để tạo tài liệu API cho các mô-đun Python của mình. Trong khi tôi có thể thấy cách ghi lại các thông số cụ thể một cách độc đáo, tôi không thể tìm thấy một ví dụ nào về cách ghi lại …

99 python  python-sphinx  autodoc