repoze.sphinx.autointerface apibrėžia už Sfinksas dokumentų sistemos taikymo. & Nbsp; plėtinys leidžia kartos API dokumentacijos savistaba iš zope.interface atvejais kodą.
Įrengimas:
Įdiekite per easy_install:
bin / easy_install repoze.sphinx.autointerface
arba bet kurios kitos priemonės, kurie gauna paketą savo PYTHONPATH.
Registracija pratęsimas
Pridėti repoze.sphinx.autointerface į plėtinių sąrašą sfinkso dokumentų jūsų produktą conf.py. E.g .:
plėtiniai = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest"
& Nbsp; "repoze.sphinx.autointerface"
& Nbsp;]
Su praplėtimu
Tuo atitinkamas kiekis jūsų dokumento, iškviesti sąsajos autodocs per:
.. :: Autointerface yourpackage.interfaces.IFoo
Išėjimo iš direktyvos apima
& Nbsp; * visiškai kvalifikuotas sąsaja vardas
& Nbsp; * bet bazė sąsajos
& Nbsp; * iš sąsaja, teikiamos kaip reSTX doctstring.
& Nbsp; * interfeiso nariai (metodai ir atributai).
& Nbsp; ° Už kiekvieną atributą, produkcija apima atributą pavadinimą ir aprašymą.
& Nbsp; O Kiekvienu metodu produkcija apima metodo pavadinimas, parašas, ir jos docstring (taip pat teikiamos kaip reSTX)
Kas naujo , šioje laidoje:.
- PyPy suderinamumas.
- Python 3.2+ suderinamumas. Ačiū Arfrever už pleistras.
- Įtraukti sąsajos docs pagal automodule direktyvą. Ačiū Krys Lawrence už pleistras.
Kas naujo versijos 0.6.2:
- Nustatyti Tipo klaida: "NoneType" objektas yra ne iterable Klaida generuojant iš sąsajos atvaizdavimo pagal Python 2.7.
Kas naujo versijos 0.6.1:
- Nustatyti ": narys užsakymą: bysource" tvarkymo .
Kas naujo versijoje 0.6:
- teisingai elgtis ": Nariai:" vertybės aiškiai nustatyti direktyva.
Kas naujo versijoje 0.5:
- Pridėta parama ": Narys-tvarka:" vėliava , kuri gali būti viena iš trijų akcijų vertybių, & quot; & quot ;, abėcėlės & quot; & quot ;, GroupWise arba & quot; bysource & quot ;. Pagal nutylėjimą, nariai dokumentais & quot; maišos & quot; tvarka.
Reikalavimai :
- Python
- Sfinksas "
Komentarai nerastas