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;]
Использование Extension
В соответствующих точках в документе, крикнуть интерфейса autodocs через:
.. :: Autointerface yourpackage.interfaces.IFoo
Выход из директивы включает в себя
& NBSP; * полностью определенное имя интерфейса
& NBSP; * любые базовые интерфейсы
& NBSP; * doctstring из интерфейса, вынесенное в reSTX.
& NBSP; * члены интерфейса (методы и атрибуты).
& NBSP; вывода для каждого атрибута, выход включает в себя имя атрибута и его описание.
& NBSP; вывода для каждого метода, выход включает в себя имя метода, его подпись, и ее строка документации (также предоставляться в качестве reSTX)

Что нового В этом выпуске:.

• совместимость PyPy.
• Python 3.2+ совместимость. Благодаря Arfrever патча.
• Включить интерфейс документы в соответствии с директивой automodule. Благодаря KRYS Лоуренс патча.

Что нового в версии 0.6.2:

• Исправлена ​​Ошибка типа: объект "NoneType 'не итерацию Ошибка при генерации оказание интерфейс под Python 2.7.

Что нового в версии 0.6.1:

• Исправлена ​​": член-заказ: bysource" обращения .

Что нового в версии 0.6:

• Правильно обращаться с ': Пользователей:' значения явно установить в Директива.

Что нового в версии 0.5:

• Добавлена ​​поддержка для ": член порядка:« флаг , который может принимать одно из трех значений фондовых, & Quot; алфавитный и Quot ;, & Quot; GroupWise и Quot ;, или & Quot; bysource & Quot ;. По умолчанию члены описаны в & Quot; хэш & Quot; порядка.

Требования

• Python
• Сфинкс