repoze.sphinx.autointerface definuje rozšíření pro systém dokumentace Sfingy. & Nbsp; rozšíření umožňuje generování dokumentace API o introspekci případů zope.interface v kódu.
Instalace:
Instalace přes easy_install:
bin / easy_install repoze.sphinx.autointerface
nebo jakékoli jiné prostředky, které dostane balíček na vašem PYTHONPATH.
Registrace rozšíření
Přidat repoze.sphinx.autointerface do seznamu rozšíření v conf.py dokumentace Sphinx pro váš produkt. Např .:
rozšíření = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest"
& Nbsp; "repoze.sphinx.autointerface"
& Nbsp;]
pomocí rozšíření
Na vhodných místech v dokumentu, zavolají na autodocs rozhraní pomocí:
.. :: Autointerface yourpackage.interfaces.IFoo
Výstup ze směrnice zahrnuje
& Nbsp; * název plně kvalifikovaný interface
& Nbsp; * všechny základní rozhraní
& Nbsp; * doctstring z rozhraní, poskytnuté jako reSTX.
& Nbsp; * členové rozhraní (metody a atributy).
& Nbsp; o Pro každý atribut, výstup obsahuje název atributu a jeho popis.
& Nbsp; o Pro každou metodu, výstup obsahuje název metody, jeho podpis a jeho dokumentačního řetězce (také vyjádřen jako reSTX)
Co je nového v této verzi:.
- kompatibilita PyPy.
- Python 3.2+ kompatibilita. Díky Arfrever za opravy.
- Zahrnout dokumenty rozhraní podle směrnice o automodule. Díky Krys Lawrence za účelem opravy.
Co je nového ve verzi 0.6.2:
- Fix TypeError: 'NoneType "objekt není iterable Chyba při generování ztvárnění rozhraní v Pythonu 2.7.
Co je nového ve verzi 0.6.1:
- Fix ': Člen-order: bysource "manipulace .
Co je nového ve verzi 0.6:
- správně zacházet s ": členové:" hodnoty výslovně stanovené v směrnice.
Co je nového ve verzi 0.5:
- Přidána podpora pro ": člen objednávku:" flag , což může mít jednu ze tří hodnot akcií, & quot; abecední a quot ;, & quot; GroupWise a quot ;, nebo & quot; bysource & quot ;. Ve výchozím nastavení, členové jsou dokumentovány v & quot; hash & quot; objednat.
Požadavky na :
- Python
- Sphinx
Komentáře nebyl nalezen