repoze.sphinx.autointerface

repoze.sphinx.autointerface define una extensión para el sistema de documentación Esfinge. & Nbsp; La extensión permite la generación de documentación de la API por introspección de instancias zope.interface en código.
Instalación:
Instale través easy_install:
bin / repoze.sphinx.autointerface easy_install
o cualquier otro medio que consigue el paquete en su PYTHONPATH.
El registro de la Extensión
Añadir repoze.sphinx.autointerface a la lista de extensiones en el conf.py de la documentación Esfinge para su producto. Por ejemplo .:
extensiones = ['sphinx.ext.autodoc',
& Nbsp; "sphinx.ext.doctest ',
& Nbsp; "repoze.sphinx.autointerface ',
& Nbsp;]
Uso de la Extensión
En los puntos apropiados en el documento, en voz alta las autodocs interfaz a través de:
.. :: Autointerface yourpackage.interfaces.IFoo
La salida de la directiva incluye
& Nbsp; * el nombre de la interfaz totalmente calificado
& Nbsp; * los interfaces base
& Nbsp; * el doctstring desde la interfaz, rendida como reSTX.
& Nbsp; * los miembros de la interfaz (métodos y atributos).
& Nbsp; o Para cada atributo, la salida incluye el nombre del atributo y su descripción.
& Nbsp; o Para cada método, el resultado incluye el nombre del método, su firma, y ​​su cadena de documentación (también traducido como reSTX)

¿Qué hay de nuevo en esta versión:.

• Compatibilidad PyPy.
• Python 3.2+ compatibilidad. Gracias a Arfrever para el parche.
• Incluya docs interfaz conforme a la directiva automodule. Gracias a Krys Lawrence para el parche.

¿Cuál es nuevo en la versión 0.6.2:

• TypeError Fix: objeto 'NoneType' no es iterable error al generar una representación de una interfaz bajo Python 2.7.

¿Qué hay de nuevo en la versión 0.6.1:

• Fix ': Miembro orden: bysource' manipulación .

¿Qué hay de nuevo en la versión 0.6:

• manejar correctamente ': miembros: "valores establecidos explícitamente en la Directiva.

¿Cuál es nuevo en la versión 0.5:

• Se ha añadido soporte para la ': Miembro orden:' bandera , que puede tomar uno de los tres valores de las acciones, & quot; & quot ;, alfabético & quot; & quot ;, groupwise o & quot; bysource & quot ;. De forma predeterminada, los miembros están documentados en & quot; de hash & quot; orden.

Requisitos :

• Python
• esfinge