repoze.sphinx.autointerface definierar en förlängning för Sphinx dokumentationssystem. & Nbsp; Förlängningen möjliggör generering av API-dokumentation genom introspektion av zope.interface instanser i koden.
Installation:
Installera via easy_install:
bin / easy_install repoze.sphinx.autointerface
eller på något annat sätt som får paketet på ditt PYTHON.
Registrera Extension
Lägg repoze.sphinx.autointerface till listan förlängningar i conf.py av Sphinx dokumentationen för din produkt. T.ex .:
extensions = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest ",
& Nbsp; 'repoze.sphinx.autointerface ",
& Nbsp;]
Använda Extension
På lämpliga ställen i dokumentet, ropar de autodocs gränssnitts via:
.. Autointerface :: yourpackage.interfaces.IFoo
Utgång från direktivet omfattar
& Nbsp; * det fullständiga gränssnittsnamn
& Nbsp; * någon bas gränssnitt
& Nbsp; * den doctstring från gränssnittet, tolkat som reSTX.
& Nbsp; * medlemmarna i gränssnittet (metoder och attribut).
& Nbsp; o För varje attribut, omfattar utgången attributnamnet och dess beskrivning.
& Nbsp; o För varje metod, innefattar utsignalen metodnamnet, undertecknandet, och dess docstring (även återges som reSTX)
Vad är nytt i den här versionen:.
- PyPy kompatibilitet.
- Python 3.2+ kompatibilitet. Tack vare Arfrever för plåstret.
- Inkludera gränssnitts docs enligt direktivet automodule. Tack vare Krys Lawrence för plåstret.
Vad är nytt i version 0.6.2:
- Fix Typfel: "NoneType" objektet inte iterable fel när du genererar en återgivning av ett gränssnitt enligt Python 2.7.
Vad är nytt i version 0.6.1:
- Fix ': medlem-order: bysource "hantering .
Vad är nytt i version 0.6:
- Korrekt hantera ': medlemmar: "värden uttryckligen anges i den direktiv.
Vad är nytt i version 0.5:
- Utökat stöd för den ": medlem-order:" flagga , vilket kan ta en av de tre lagervärden, & quot; alfabetisk & quot ;, & quot; gruppvis & quot ;, eller & quot; bysource & quot ;. Som standard är medlemmar dokumenterade i & quot; hash & quot; ordning.
Krav :
- Python
- Sphinx
Kommentarer hittades inte