repoze.sphinx.autointerface definerer en forlængelse af den Sphinx dokumentationssystem. & Nbsp; Udvidelsen muliggør generering af API-dokumentation ved introspektion af zope.interface tilfælde i kode.
Installation:
Installer via easy_install:
bin / easy_install repoze.sphinx.autointerface
eller andet, som får pakken på din PYTHONPATH.
Registrering af Extension
Føj repoze.sphinx.autointerface til listen udvidelser i conf.py af Sphinx dokumentation til dit produkt. F.eks .:
extensions = ['sphinx.ext.autodoc «,
& Nbsp; "sphinx.ext.doctest«,
& Nbsp; "repoze.sphinx.autointerface«,
& Nbsp;]
Brug af Extension
Med passende punkter i dit dokument, råber interface autodocs via:
.. Autointerface :: yourpackage.interfaces.IFoo
Output fra direktivet indeholder
& Nbsp; * det fuldt kvalificerede grænseflade navn
& Nbsp; * helst base interfaces
& Nbsp; * den doctstring fra grænsefladen, gengivet som reSTX.
& Nbsp; * medlemmerne af grænsefladen (metoder og attributter).
& Nbsp; o For hver egenskab, output omfatter attributnavnet og dens beskrivelse.
& Nbsp; o For hver metode, output omfatter metoden navn, underskrift og dens docstrengen (også gengivet som reSTX)
Hvad er nyt i denne udgivelse:.
- PYPY kompatibilitet.
- Python 3.2+ kompatibilitet. Takket være Arfrever for plasteret.
- Medtag grænseflade docs henhold til direktivet automodule. Tak til Krys Lawrence for plasteret.
Hvad er nyt i version 0.6.2:
- Fix TypeError: »NoneType 'objekt er ikke Iterable fejl, når du genererer en gengivelse af en grænseflade under Python 2.7.
Hvad er nyt i version 0.6.1:
- Fix ': Medlem-rækkefølge: bysource' håndtering .
Hvad er nyt i version 0.6:
- Korrekt håndtere ': Brugere: værdier udtrykkeligt angivet i direktiv.
Hvad er nyt i version 0.5:
- Tilføjet støtte til ": Medlem-order: 'flag , som kan tage en af de tre lagerværdi, & quot; alfabetisk & quot ;, & quot; GroupWise & quot ;, eller & quot; bysource & quot ;. Som standard er medlemmer dokumenteret i & quot; hash & quot; orden.
Krav :
- Python
- Sphinx
Kommentarer ikke fundet