repoze.sphinx.autointerface definerer en utvidelse for Sphinx dokumentasjonssystem. & Nbsp; Utvidelsen gjør generasjon av API dokumentasjon av introspeksjon av zope.interface tilfeller i kode.
Installasjon:
Installere via easy_install:
bin / easy_install repoze.sphinx.autointerface
eller på annen måte som får pakken på ditt PYTHONPATH.
Registrere Extension
Legg repoze.sphinx.autointerface til listen utvidelser i conf.py Sfinksen dokumentasjonen for produktet. F.eks .:
utvidelser = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Bruke Extension
På passende steder i dokumentet, kan du ringe ut grensesnitt autodocs via:
.. Autointerface :: yourpackage.interfaces.IFoo
Utgang fra direktivet omfatter
& Nbsp; * det fullt kvalifisert navn grensesnitt
& Nbsp; * noen grunn grensesnitt
& Nbsp; * den doctstring fra grensesnittet, gjengitt som reSTX.
& Nbsp; * medlemmene av grensesnittet (metoder og attributter).
& Nbsp; o For hvert attributt, omfatter utgangs attributtet navn og beskrivelse.
& Nbsp; o For hver metode, omfatter utgangsmetodenavnet, sin signatur, og dens docstring (også gjengitt som reSTX)
Hva er nytt i denne utgaven:.
- PYPY kompatibilitet.
- Python 3.2+ kompatibilitet. Takk til Arfrever for lappen.
- Inkluder grensesnitt docs under automodule direktivet. Takk til Krys Lawrence for lappen.
Hva er nytt i versjon 0.6.2:
- Fix Feiltype: 'NoneType' objekt er ikke iterable feil ved generering av en gjengivelse av et grensesnitt i henhold til Python 2.7.
Hva er nytt i versjon 0.6.1:
- Fix ': medlem-order: bysource' håndtering .
Hva er nytt i versjon 0.6:
- Korrekt håndtere ': Medlemmer:' verdier eksplisitt satt i direktiv.
Hva er nytt i versjon 0.5:
- Lagt til støtte for den ': medlem bestilling:' flagg , som kan ta en av de tre lagerverdier, & quot; alfabetisk & quot ;, & quot; gruppevis & quot ;, eller & quot; bysource & quot ;. Som standard er medlemmer dokumentert i & quot; hash & quot; rekkefølge.
Krav :
- Python
- Sphinx
Kommentarer ikke funnet