repoze.sphinx.autointerface

repoze.sphinx.autointerface tumutukoy sa isang extension para sa Sphinx dokumentasyon ng sistema. & Nbsp; ay nagbibigay-daan ang extension ng pagbuo ng mga babasahin ukol sa API sa pamamagitan ng pagsisiyasat ng sarili ng mga pagkakataon sa zope.interface code.
Pag-install:
I-install sa pamamagitan ng easy_install:
bin / easy_install repoze.sphinx.autointerface
o anumang iba pang paraan na nakakakuha ng pakete sa iyong PYTHONPATH.
Nirerehistro ang Extension
Magdagdag ng repoze.sphinx.autointerface sa listahan ng mga extension sa conf.py ng dokumentasyon Sphinx para sa iyong produkto. Hal .:
extension = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
Ang paggamit ng Extension
Sa naaangkop na mga punto sa iyong dokumento, tawagan ang autodocs interface sa pamamagitan ng:
.. Autointerface :: yourpackage.interfaces.IFoo
Output mula sa kautusang Kasama
& Nbsp; * ang ganap na kwalipikadong pangalan interface
& Nbsp; * anumang base interface
& Nbsp; * ang doctstring mula sa interface, render bilang reSTX.
& Nbsp; * ang mga kasapi ng interface (mga pamamaraan at mga katangian).
& Nbsp; o Para sa bawat katangian, ang output ay kinabibilangan ng mga pangalan ng katangian at paglalarawan nito.
& Nbsp; o Para sa bawat paraan, ang output ay kinabibilangan ng mga pangalan ng pamamaraan, lagda nito, at ang mga docstring (render na rin bilang reSTX)

Ano ang bagong sa paglabas:.

• PyPy compatibility.
• Python 3.2+ compatibility. Salamat sa Arfrever para sa patch.
• Isama ang interface doc sa ilalim ng automodule panuto. Salamat sa Krys Lawrence para sa patch.

Ano ang bagong sa bersyon 0.6.2:

• Ayusin ang TypeError: 'NoneType' object ay hindi iterable error kapag bumubuo ng isang pag-render ng isang interface sa ilalim ng Python 2.7.

Ano ang bagong sa bersyon 0.6.1:

• Ayusin ang ': miyembro-order: bysource' handling .

Ano ang bagong sa bersyon 0.6:

• Tamang mahawakan ang ': kasapi:' mga halaga tahasang itinakda sa directive.

Ano ang bagong sa bersyon 0.5:

• Nagdagdag ng suporta para sa ': miyembro-order:' na flag , na maaaring tumagal ng isa sa tatlong mga halaga ng stock, & quot; alpabetikong & quot ;, & quot; groupwise & quot ;, o & quot; bysource & quot ;. Sa pamamagitan ng default, ang mga miyembro ay dokumentado sa & quot; hash & quot; pagkakasunud-sunod.

Mga Kinakailangan :

• Python
• Sphinx