repoze.sphinx.autointerface

repoze.sphinx.autointerface define uma extensão para o sistema de documentação Sphinx & nbsp;. A extensão permite a geração de documentação da API pela introspecção de instâncias zope.interface em código.
Instalação:
Instale via easy_install:
bin / repoze.sphinx.autointerface easy_install
ou qualquer outro meio, que recebe o pacote no seu PYTHONPATH.
Registrando o Extension
Adicionar repoze.sphinx.autointerface à lista de extensões no conf.py da documentação Sphinx para seu produto. G .:
extensões = ['sphinx.ext.autodoc',
& Nbsp; "sphinx.ext.doctest ',
& Nbsp; "repoze.sphinx.autointerface ',
& Nbsp;]
usando a extensão
Em pontos apropriados no documento, chamar as autodocs de interface via:
.. :: Autointerface yourpackage.interfaces.IFoo
Saída da directiva inclui
& Nbsp; * o nome da interface totalmente qualificado
& Nbsp; * quaisquer interfaces base
& Nbsp; * o doctstring a partir da interface, rendida como reSTX.
& Nbsp; * os membros de interface (métodos e atributos).
& Nbsp; o Para cada atributo, a saída inclui o nome do atributo e sua descrição.
& Nbsp; o Para cada método, a saída inclui o nome do método, a sua assinatura e da sua docstring (também processado como reSTX)

O que é novo nesta versão:.

• compatibilidade PyPy.
• Python 3.2+ compatibilidade. Graças a Arfrever para o patch.
• Incluir docs de interface ao abrigo da directiva automodule. Graças a Krys Lawrence para o patch.

O que é novo na versão 0.6.2:

• Fix TypeError: objeto 'NoneType' não é iterable erro ao gerar uma renderização de uma interface sob Python 2.7.

O que é novo na versão 0.6.1:

• Fix ': membro de ordem: bysource «manipulação .

O que é novo na versão 0.6:

• Corretamente lidar com ': membros: «valores explicitamente definido no directiva.

O que é novo na versão 0.5:

• Adicionado suporte para o ': membro de ordem:' flag , que pode assumir um dos três valores de ações, & quot; alfabética & quot ;, & quot; GroupWise & quot ;, ou & quot; bysource & quot ;. Por padrão, os membros são documentados em & quot; de hash & quot; ordem.

Requisitos :

• Python
• Sphinx