repoze.sphinx.autointerface

repoze.sphinx.autointerface mendefinisikan ekstensi untuk sistem dokumentasi Sphinx & nbsp;. Ekstensi memungkinkan generasi dokumentasi API dengan introspeksi contoh zope.interface dalam kode.
Instalasi:
Instal melalui easy_install:
bin / easy_install repoze.sphinx.autointerface
atau cara lain yang mendapat paket pada PYTHONPATH Anda.
Mendaftarkan Extension
Tambahkan repoze.sphinx.autointerface ke daftar ekstensi di conf.py dokumentasi Sphinx untuk produk Anda. Mis .:
ekstensi = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Menggunakan Ekstensi
Pada titik yang sesuai dalam dokumen Anda, panggilan keluar autodocs antarmuka melalui:
.. :: Autointerface yourpackage.interfaces.IFoo
Output dari direktif meliputi
& Nbsp; * nama antarmuka sepenuhnya memenuhi syarat
& Nbsp; * setiap antarmuka dasar
& Nbsp; * yang doctstring dari antarmuka, diberikan sebagai reSTX.
& Nbsp; * anggota antarmuka (metode dan atribut).
& Nbsp; o Untuk setiap atribut, output meliputi nama atribut dan deskripsi.
& Nbsp; o Untuk setiap metode, output termasuk nama metode, tanda tangan, dan docstring (juga diterjemahkan sebagai reSTX)

Apa yang baru dalam rilis ini:.

• kompatibilitas PyPy.
• Python 3.2+ kompatibilitas. Berkat Arfrever untuk patch.
• Sertakan antarmuka docs di bawah arahan automodule. Terima kasih kepada Krys Lawrence untuk patch.

Apa yang baru dalam versi 0.6.2:

• Fix TypeError: objek 'NoneType' tidak iterable kesalahan saat membuat rendering dari antarmuka bawah Python 2.7.

Apa yang baru dalam versi 0.6.1:

• Fix ': anggota-order: bysource' penanganan
.

Apa yang baru dalam versi 0.6:

• Benar menangani ': Anggota:' nilai-nilai secara eksplisit diatur dalam direktif.

Apa yang baru dalam versi 0.5:

• Ditambahkan dukungan untuk ': anggota-order:' flag , yang dapat mengambil salah satu dari nilai saham tiga, & quot; & quot ;, abjad & quot; & quot ;, GroupWise atau & quot; bysource & quot ;. Secara default, anggota didokumentasikan dalam & quot; hash & quot; order.

Persyaratan :

• Python
• Sphinx