repoze.sphinx.autointerface

repoze.sphinx.autointerface definește o extensie pentru sistemul de documentare Sfinxul. & Nbsp; Extinderea permite generarea de documentare API de introspecție de instanțe zope.interface din cod.
Instalare:
Instalați prin easy_install:
bin / repoze.sphinx.autointerface easy_install
sau orice alte mijloace care devine pachetul pe PYTHONPATH dumneavoastră.
Înregistrarea extensia
Adăugați repoze.sphinx.autointerface la lista de extensii în conf.py documentației Sphinx pentru produsul dumneavoastră. De exemplu .:
extensii = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest",
& Nbsp; "repoze.sphinx.autointerface",
& Nbsp;]
Cu extensia
La punctele corespunzătoare din documentul dvs., striga la autodocs interfață prin:
.. Autointerface :: yourpackage.interfaces.IFoo
Ieșire din directiva include
& Nbsp; * numele interfeței complet calificat
& Nbsp; * interfețe de bază
& Nbsp; * doctstring de interfata, prestate în calitate de reSTX.
& Nbsp; * membrii interfeței (metode și atribute).
& Nbsp; o Pentru fiecare atribut, ieșirea include numele atributului și descrierea acestuia.
& Nbsp; o Pentru fiecare metodă, producția cuprinde numele metodei, semnătura ei, și docstring ei (de asemenea redate ca reSTX)

Ce este nou în această versiune:.

• compatibilitate PyPy.
• Python 3.2+ compatibilitate. Vă mulțumim pentru Arfrever pentru plasturele.
• Includeți documente de interfață în temeiul directivei automodule. Vă mulțumim pentru Krys Lawrence pentru plasturele.

Ce este nou în versiunea 0.6.2:

• Fix TypeError: obiect "NoneType" nu este iterable Eroare la generarea o redare a unei interfețe în Python 2.7.

Ce este nou în versiunea 0.6.1:

• Fix ": Membru-comandă: bysource" manipulare .

Ce este nou în versiunea 0,6:

• ocupe în mod corect ": membri:" valori stabilite în mod explicit în directivă.

Ce este nou în versiunea 0.5:

• Adăugat suport pentru ': Membru-comanda: "pavilion , care poate lua una dintre cele trei valori comerciale, & quot; & quot ;, alfabetică & quot; & quot ;, GroupWise sau & quot; & quot ;. bysource În mod implicit, membrii sunt documentate în & quot; hash & quot; comanda.

Cerințe :

• Python
• Sfinxul