repoze.sphinx.autointerface

repoze.sphinx.autointerface определя разширение на системата Сфинкс документация & Nbsp;. Разширението позволява генериране на документация API от самоанализ на zope.interface инстанции по код.
<Силен> Монтаж:
Инсталирайте чрез easy_install:
Бин / easy_install repoze.sphinx.autointerface
или всякакви други средства, които получава пакета на вашия PYTHONPATH.
<Силен> Регистриране разширение
Добави repoze.sphinx.autointerface в списъка с разширения в conf.py на документацията Сфинкс за вашия продукт. Напр .:
разширенията = ['sphinx.ext.autodoc ",
& Nbsp; "sphinx.ext.doctest",
& Nbsp; "repoze.sphinx.autointerface",
& Nbsp;]
<Силен> Използване разширение
В подходящи точки от документа ви, обадете се на autodocs интерфейс чрез:
.. :: Autointerface yourpackage.interfaces.IFoo
Output от директивата включва
& Nbsp; * напълно квалифицирано име на интерфейс
& Nbsp; * някакви базови интерфейси
& Nbsp; * на doctstring от интерфейса, постановено по reSTX.
& Nbsp; * членовете на интерфейс (методи и атрибути).
& Nbsp; о За всеки атрибут, продукцията включва името на атрибут и неговото описание.
& Nbsp; о За всеки метод, продукцията включва името на метода, подписването му, и неговата docstring (също направи като reSTX)

Какво ново в тази версия:.

• PyPy съвместимост.
• Python 3.2+ съвместимост. Благодарение на Arfrever за пластира.
• Включи интерфейс Документи по директивата за automodule. Благодарение на Krys Lawrence за пластира.

Какво ново във версия 0.6.2:

• Fix Тип грешка: обект "NoneType" не е iterable Грешка при генериране на предоставяне на интерфейс по Python 2.7.

Какво ново във версия 0.6.1:

• Fix ": Държавите-цел: bysource" боравене .

Какво ново във версия 0.6:

• правилно с ": Членове:" ценности изрично определени в директива.

Какво ново във версия 0.5:

• Добавена е поддръжка за ": Държавите-ред:" знаме , което може да отнеме една от трите борсови стойности, & quot; азбучен & quot ;, & quot; GroupWise & quot ;, или & quot; bysource & quot ;. По подразбиране, членовете са документирани в & quot; хеш & quot; ред.

<силни> Изисквания :

• Python
• Сфинкс