repoze.sphinx.autointerface określa rozszerzenie dla systemu dokumentacji Sphinx. & Nbsp; rozszerzenie umożliwia generowanie dokumentacji API poprzez introspekcję przypadków zope.interface w kodzie.
Instalacja:
Instalowanie za pomocą easy_install:
bin / easy_install repoze.sphinx.autointerface
lub jakiekolwiek inne środki, które dostaje pakiet na PYTHONPATH.
Rejestrowanie Extension
Dodaj repoze.sphinx.autointerface do listy rozszerzeń w conf.py dokumentacji Sphinx na produkt. Na Przykład .:
Rozszerzenia = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest",
& Nbsp; "repoze.sphinx.autointerface",
& Nbsp;]
Korzystanie z rozszerzeniem
W odpowiednich miejscach w dokumencie, wołać o autodocs interfejsu poprzez:
.. Autointerface :: yourpackage.interfaces.IFoo
Wyjście z dyrektywy zawiera
& Nbsp; * pełna nazwa interfejsu
& Nbsp; * wszelkie interfejsy bazowe
& Nbsp; * doctstring z interfejsu, świadczonych w reSTX.
& Nbsp; * członkowie interfejsu (metody i atrybuty).
& Nbsp; o Dla każdego atrybutu, wyjście zawiera nazwę atrybutu i jego opis.
& Nbsp; o W przypadku każdej metody, wyjście zawiera nazwę metody, jej podpisanie oraz jego docstring (także świadczonych w reSTX)
Co nowego w tym wydaniu:.
- Kompatybilność PyPy.
- Python 3.2+ kompatybilność. Dzięki Arfrever do poprawki.
- Dołącz dokumentacji interfejsu w ramach dyrektywy w automodule. Dzięki Krys Lawrence za poprawki.
Co nowego w wersji 0.6.2:
- Fix Błąd typu: obiekt "NoneType 'nie jest iterable Błąd podczas generowania renderowania interfejsu w Pythonie 2.7.
Co nowego w wersji 0.6.1:
- Fix ": członek rzędu: bysource" obchodzenia .
Co nowego w wersji 0.6:
- poprawnie obsłużyć ': Członkowie: "wartości jawnie ustawić w dyrektywy.
Co nowego w wersji 0.5:
- Dodano wsparcie dla ": Państwa-order:" Flaga , który może przyjąć jedną z trzech akcji wartości, & quot; & quot ;, alfabetyczne & quot; & quot ;, GroupWise lub & quot; & quot ;. bysource Domyślnie członkowie są udokumentowane w & quot; hasz & quot; zamówienie.
Wymagania :
- Python
- Sfinks
Komentarze nie znaleziono