repoze.sphinx.autointerface

repoze.sphinx.autointerface definieert een uitbreiding voor de Sphinx documentatiesysteem & nbsp;. De uitbreiding maakt het mogelijk generatie van de API-documentatie door introspectie van zope.interface gevallen in de code.
Installatie:
Installeren via easy_install:
bin / easy_install repoze.sphinx.autointerface
of andere middelen die het pakket krijgt op uw PYTHONPATH.
Het registreren van de Extension
Repoze.sphinx.autointerface toe te voegen aan de lijst met extensies in de conf.py van de Sphinx documentatie voor uw product. Bijv .:
extensions = ['sphinx.ext.autodoc,
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Met de Extension
Op passende punten in uw document, roepen de interface autodocs via:
.. Autointerface :: yourpackage.interfaces.IFoo
Output van de richtlijn bevat
& Nbsp; * de volledig gekwalificeerde interface van naam
& Nbsp; * elke base interfaces
& Nbsp; * de doctstring van de interface, weergegeven als reSTX.
& Nbsp; * de leden van de interface (methoden en attributen).
& Nbsp; o Voor elk attribuut, de output bevat de naam attribuut en de beschrijving ervan.
& Nbsp; o Voor elke methode, de output omvat de naam van de methode, de ondertekening, en haar docstring (ook weergegeven als reSTX)

Wat is nieuw in deze release:.

• pypy compatibiliteit.
• Python 3.2+ compatibiliteit. Dankzij Arfrever voor de patch.
• Include-interface docs onder de richtlijn automodule. Dankzij Krys Lawrence voor de patch.

Wat is nieuw in versie 0.6.2:

• Fix TypeError: 'NoneType' object is niet iterable fout bij het genereren van een weergave van een interface onder Python 2.7.

Wat is nieuw in versie 0.6.1:

• Fix ': lid-order: bysource' handling .

Wat is nieuw in versie 0.6:

• Correct afhandelen ': leden:' waarden expliciet in de richtlijn.

Wat is nieuw in versie 0.5:

• Ondersteuning toegevoegd voor de ': lid-order:' vlag , die kan een van de drie beurskoersen, & quot nemen; alfabetische & quot ;, & quot; groepsgewijze & quot ;, of & quot; bysource & quot ;. Standaard worden de leden gedocumenteerd in & quot; hash & quot; volgorde.

Eisen

• Python
• Sphinx