14
Tôi đang cố dọn sạch tài liệu mã python của mình và quyết định sử dụng sphinx-doc vì nó có vẻ tốt. Tôi thích làm thế nào tôi có thể tham khảo các lớp học và các phương pháp khác với các thẻ như:Làm thế nào để ghi lại các tham số hàm Python với sphinx-apidoc
:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function
Tôi đang cố gắng để tìm ra mặc dù làm thế nào để ghi tên tham số trong một hàm, do đó nếu tôi có một chức năng như:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something?:`parameter1` And then describe the parameter.
"""
Thực tiễn tốt nhất cho việc này là gì?
Cập nhật:
Cú pháp đúng là:
def do_this(parameter1, parameter2):
"""
I can describe do_this.
:something parameter1: And then describe the variable
"""
Chúng được gọi là "danh sách trường thông tin". Xem thêm http://stackoverflow.com/questions/4547849/good-examples-of-python-docstrings-for-sphinx – gotgenes
Khám phá [Napolean] (http://www.sphinx-doc.org/en/stable /ext/napoleon.html) mở rộng cho Sphinx, cho phép chuỗi tài liệu theo [Google hoặc kiểu Numpy] (http://www.sphinx-doc.org/en/stable/ext/napoleon.html#google-vs- numpy), cả hai trông đẹp hơn Sphinx đơn giản. – cbare
Cũng quan tâm: http://www.pydev.org/manual_adv_type_hints.html –