repoze.sphinx.autointerface meghatározza egy kiterjesztés a Szfinx dokumentációs rendszer. & Nbsp; A kiterjesztés lehetővé teszi generációs API dokumentációt önvizsgálat a zope.interface esetek kódot.
Telepítés:
Telepítés az easy_install:
bin / easy_install repoze.sphinx.autointerface
vagy bármilyen más módon megkapja a csomagot a PYTHONPATH.
regisztrálása Extension
Add repoze.sphinx.autointerface a kiterjesztések listája conf.py a Szfinx dokumentációt a termékhez. Pl .:
extensions = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest",
& Nbsp; "repoze.sphinx.autointerface",
& Nbsp;]
A bővítő
A megfelelő helyeken a dokumentumban, hívja ki a felületet autodocs keresztül:
.. :: Autointerface yourpackage.interfaces.IFoo
Kimenetét az irányelv tartalmazza
& Nbsp; * a teljes hálózati interfész neve
& Nbsp; * bármilyen alapú interfészek
& Nbsp; * a doctstring a felületet, renderelt, mint reSTX.
& Nbsp; * a tagok a felület (módszereit és attribútumok).
& Nbsp; o Minden egyes attribútum, a kimenet tartalmazza az attribútum nevét és leírását.
& Nbsp; o Minden egyes módszer, a kimenet tartalmazza a metódus nevét, aláírását, és docstring (is nyújtott, mint reSTX).
Mi az új ebben a kiadásban:
- PyPy kompatibilitást.
- Python 3.2+ kompatibilitás. Hála Arfrever a patch.
- interfész-docs alatt automodule irányelv. Hála Krys Lawrence a patch.
Mi az új verzióban 0.6.2:
- Fix Típushiba: "NoneType" objektum nem iterable error generálása során a renderelés egy interfész mellett Python 2.7.
Mi az új verzióban 0.6.1:
- Fix ": tag-sorrendben: bysource" kezelését .
Mi az új a 0.6 verzió:
- Megfelelően kezeli ": tagjai: 'értékek egyértelműen meghatározva a irányelv.
Mi az új a 0.5 verzió:
- A támogatás a ": tag-sorrendben:" flag , amely akár a három tőzsdei értékek & quot; alfabetikus & quot ;, & quot; GroupWise & quot ;, illetve & quot; bysource & quot ;. Alapértelmezésben tagjai dokumentálni & quot; hash & quot; érdekében.
követelmények :
- Python
- Sphinx
Hozzászólás nem található