repoze.sphinx.autointerface

repoze.sphinx.autointerface definiert eine Erweiterung für den Sphinx-Dokumentationssystem. & Nbsp; Die Erweiterung ermöglicht Generation von API-Dokumentation durch Introspektion von zope.interface Instanzen in Code.
Installation:
Installieren Sie über easy_install:
bin / easy_install repoze.sphinx.autointerface
oder andere Mittel, die das Paket auf Ihrem PYTHONPATH wird.
Registrieren der Erweiterung
Fügen repoze.sphinx.autointerface auf die Erweiterungen in der Liste conf.py der Sphinx-Dokumentation für Ihr Produkt. Z.B .:
Erweiterungen = ['sphinx.ext.autodoc',
& Nbsp; "sphinx.ext.doctest ',
& Nbsp; "repoze.sphinx.autointerface ',
& Nbsp;]
Mit der Erweiterung
An geeigneten Stellen in Ihrem Dokument, rufen Sie die Schnittstelle Autodocs über:
.. :: Autointerface yourpackage.interfaces.IFoo
Ausgang aus der Richtlinie enthält
& Nbsp; * für den vollständig qualifizierten Namen der Schnittstelle
& Nbsp; * alle Basisschnittstellen
& Nbsp; * die doctstring von der Schnittstelle, wie reSTX gemacht.
& Nbsp; * die Mitglieder der Schnittstelle (Methoden und Attribute).
& Nbsp; o für jedes Attribut, enthält die Ausgabe den Attributnamen und die Beschreibung.
& Nbsp; o Für jede Methode, enthält die Ausgabe den Namen der Methode, ihre Unterschrift und ihren Docstring (auch als reSTX gemacht)

Was ist neu in dieser Pressemitteilung:.

• PyPy Kompatibilität.
• Python 3.2 und höher kompatibel. Dank für das Patch Arfrever.
• Fügen Schnittstelle docs unter der automodule Richtlinie. Dank Krys Lawrence für den Patch.

Was ist neu in Version 0.6.2:

• Fix Typeerror: 'Nonetype "Objekt nicht abzählbaren Fehler bei der Erzeugung eines Rendering einer Schnittstelle unter Python 2.7.

Was ist neu in Version 0.6.1:

• Fix ": Mitglied Ordnung: bysource 'Handhabung .

Was ist neu in Version 0.6:

• richtig handhaben ": Mitglieder: 'Werte explizit in der festgelegt Richtlinie.

Was ist neu in Version 0.5:

• Unterstützung für die ': Mitglied Ordnung: "Flagge , die einer der drei Bestandswerte, & quot erfolgen; alphabetischer & rdquo ;, & rdquo; & quot ;, gruppen oder & quot; & quot ;. bysource Standardmäßig werden die Mitglieder in & quot dokumentiert; Hash & quot; Ordnung.

Anforderungen :

• Python
• Sphinx