repoze.sphinx.autointerface

repoze.sphinx.autointerface definieer 'n uitbreiding vir die Sphinx dokumentasie stelsel. & Nbsp; Die uitbreiding kan generasie van API dokumentasie deur introspeksie van zope.interface gevalle in die kode.
Installasie:
Installeer via easy_install:
bin / easy_install repoze.sphinx.autointerface
of op enige ander wyse wat kry die pakket op jou PYTHONPATH.
Registrasie op die Uitbreiding
Voeg repoze.sphinx.autointerface die uitbreidings lys in die conf.py van die Sphinx dokumentasie vir jou produk. Bv .:
uitbreidings = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Gebruik die Uitbreiding
Op gepaste plekke in jou dokument, roep die koppelvlak autodocs via:
.. Autointerface :: yourpackage.interfaces.IFoo
Uitvoer van die richtlijn sluit
& Nbsp; * die ten volle gekwalifiseerde koppelvlak naam
& Nbsp; * enige basis koppelvlakke
& Nbsp; * die doctstring van die koppelvlak, gelewer reSTX.
& Nbsp; * die lede van die koppelvlak (metodes en eienskappe).
& Nbsp; o Vir elke kenmerk, die uitset sluit die kenmerk naam en die beskrywing.
& Nbsp; o Vir elke metode, die uitset sluit die metode naam, sy handtekening, en sy docstring (ook gelewer reSTX)

Wat is nuut in hierdie release:.

• PyPy verenigbaarheid.
• Python 3.2+ verenigbaarheid. Danksy Arfrever vir die regstelling.
• Sluit koppelvlak docs onder die automodule richtlijn. Danksy Krys Lawrence vir die regstelling.

Wat is nuut in die weergawe 0.6.2:

• Fix TypeError: "NoneType 'n voorwerp is nie iterable fout genereer 'n lewering van 'n koppelvlak onder Python 2.7.

Wat is nuut in die weergawe 0.6.1:

• Fix ': lid-volgorde: bysource se hantering .

Wat is nuut in die weergawe 0.6:

• korrek te hanteer ': lede: "waardes uitdruklik in die richtlijn.

Wat is nuut in die weergawe 0.5:

• Bygevoeg steun vir die ': lid-orde: "vlag , wat een van die drie voorraad waardes, & quot kan neem nie; alfabetiese & quot ;, & quot; GroupWise & quot ;, of & quot; bysource & quot ;. By verstek, is lede gedokumenteer in & quot; hash & quot; orde.

Vereistes :

• Python
• Sphinx