repoze.sphinx.autointerface

.

repoze.sphinx.autointerface bir Sphinx sənədləşmə sistemi üzrə məsləhət & nbsp müəyyən edir; uzadılması kodu zope.interface hallarda introspection ilə API sənədlərin nəsil verir.
Quraşdırma:
Easy_install vasitəsilə bərpa edin:
bin / easy_install repoze.sphinx.autointerface
və ya PYTHONPATH paketi olur hər hansı digər vasitələrlə.
Daxili qeydiyyatdan
Sizin məhsul üçün Sphinx sənədlərin conf.py ilə uzantıları siyahısına repoze.sphinx.autointerface əlavə edin. E.g .:
uzantıları = ['sphinx.ext.autodoc,
& Nbsp; 'sphinx.ext.doctest,
& Nbsp; 'repoze.sphinx.autointerface,
& Nbsp;]
Daxili istifadə
Sənəd müvafiq bal da, interface autodocs vasitəsilə zəng:
.. Autointerface :: yourpackage.interfaces.IFoo
Direktiv Çıxdı daxildir
& Nbsp; * Tam ixtisaslı interface adı
& Nbsp; * Hər hansı bir əsas interfeys
& Nbsp; * reSTX kimi göstərilən interface olan doctstring.
& Nbsp; * interface üzvləri (üsulları və atributları).
& Nbsp; hər atributu üçün o, çıxış atributu adı və onun təsviri daxildir.
& Nbsp; hər metodu üçün çıxış metodu adı, imza, və (həmçinin reSTX kimi göstərilən) onun docstring daxildir o

Bu azad Yeni nədir.

• PyPy uyğunluğu.
• Python 3.2 + uyğunluğu. Thanks patch Arfrever üçün.
• automodule direktiv altında interface docs əlavə edin. Patch Krys Lawrence üçün təşəkkür edirik.

nədir versiya 0.6.2-ci Yeni

Fix TypeError

• : "NoneType 'obyekti Iterable deyil səhv Python 2.7 altında bir interfeys bir göstərilməsi oluştururken.

versiya 0.6.1 yeni nədir:

• Fix: üzv üçün: bysource 'rəftar .

nədir versiya 0.6-ci ildə Yeni

• düzgün idarə: üzvləri: "dəyərlər aydın müəyyən direktiv.

versiya 0.5 yeni nədir:

• üçün əlavə dəstək: üzv üçün: 'bayraq olan üç səhmdar dəyərlərdən biri, və quot edə bilər, əlifba & quot ;, & quot; GroupWise & quot ;, ya & quot; bysource & quot ;. Mənim cari olaraq, üzvləri & quot sənədləşdirilir, hash & quot; üçün.

tələblər

• Python
• Sphinx