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
Вихід з директиви включає в себе
І NBSP; * Повне ім'я інтерфейсу
І NBSP; * будь-яку підставу, інтерфейси
І NBSP; * doctstring з інтерфейсу, винесене в reSTX.
І NBSP; * члени інтерфейсу (методи і атрибути).
І NBSP; виводу для кожного атрибута, вихід включає в себе ім'я атрибута і його опис.
І NBSP; виводу для кожного методу, вихід включає в себе ім'я методу, його підпис, а його рядок документації (також надаватися в якості reSTX)
Що нового У цьому випуску :.
- сумісність PyPy.
- Python 3.2+ сумісність. Завдяки Arfrever патча.
- Включити інтерфейсу документи відповідно до Директиви automodule. Завдяки KRYS Лоуренс патча.
Що нового у версії 0.6.2:
- Fix Помилка типу: об'єкт "NoneType» не ітерацію Помилка при створенні візуалізації інтерфейсу, під Python 2.7.
Що нового у версії 0.6.1:
- Fix ': член-замовлення: bysource "звернення .
Що нового у версії 0.6:
- Правильно обробляти ": користувачів: 'значення явно встановити в Директива.
Що нового у версії 0.5:
- Додана підтримка для ": член порядку:« прапор , яка може приймати одне з трьох фондових цінностей, & Quot; алфавітний і Quot;, & Quot; GroupWise і Quot;, або & Quot; bysource і Quot;. За замовчуванням члени описані в & Quot; хеш & Quot; замовлення.
Вимоги
- Python
- Сфінкс
Коментар не знайдено