repoze.sphinx.autointerface

repoze.sphinx.autointerface định nghĩa một phần mở rộng cho hệ thống tài liệu Sphinx & nbsp;. Các phần mở rộng cho phép tạo ra các tài liệu API của các trường hợp mẫn zope.interface trong mã.
Cài đặt:
Cài đặt qua easy_install:
bin / easy_install repoze.sphinx.autointerface
hoặc bất kỳ phương tiện khác mà được các gói trên PYTHONPATH của bạn.
Đăng ký mở rộng
Thêm repoze.sphinx.autointerface vào danh sách các phần mở rộng trong conf.py của tài liệu Sphinx cho sản phẩm của bạn. Ví dụ: .:
phần mở rộng = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Sử dụng Extension
Tại điểm thích hợp trong tài liệu của bạn, gọi ra autodocs giao diện thông qua:
.. :: Autointerface yourpackage.interfaces.IFoo
Đầu ra những chỉ thị bao gồm
& Nbsp; * tên giao diện đầy đủ điều kiện
& Nbsp; * bất kỳ giao diện cơ sở
& Nbsp; * các doctstring từ giao diện, kết xuất như reSTX.
& Nbsp; * các thành viên của giao diện (các phương pháp và các thuộc tính).
& Nbsp; o Đối với mỗi thuộc tính, sản lượng bao gồm các tên thuộc tính và mô tả của chúng.
& Nbsp; o Đối với mỗi phương pháp, sản lượng bao gồm các tên phương pháp, chữ ký của mình, và docstring của nó (cũng kết như reSTX)

là gì mới trong phiên bản này:.

• tương thích PyPy.
• Python 3.2+ khả năng tương thích. Nhờ Arfrever cho các bản vá.
• Bao gồm tài liệu giao diện theo chỉ thị automodule. Nhờ Krys Lawrence cho các bản vá.

là gì mới trong phiên bản 0.6.2:

• Fix Lỗi Loại: đối tượng 'NoneType' là không iterable lỗi khi tạo một rendering của một giao diện dưới Python 2.7.

là gì mới trong phiên bản 0.6.1:

• Fix ': thành viên đặt hàng: bysource' xử lý .

là gì mới trong phiên bản 0.6:

• Chính xác xử lý: Các thành viên: "giá trị một cách rõ ràng thiết lập trong Chỉ thị.

là gì mới trong phiên bản 0.5:

• Thêm hỗ trợ cho các ': thành viên đặt hàng:' cờ , mà có thể mất một trong ba giá trị cổ phiếu, & quot; tự chữ cái & quot ;, & quot; & quot ;, GroupWise hoặc & quot; bysource & quot ;. Theo mặc định, các thành viên được ghi trong & quot; & quot băm; trật tự.

Yêu cầu :

• Python
• Sphinx