repoze.sphinx.autointerface

repoze.sphinx.autointerface définit une extension pour le système de documentation Sphinx. & Nbsp; L'extension permet la génération de documentation de l'API par l'introspection de cas zope.interface dans le code.
Installation:
Installer via easy_install:
bin / repoze.sphinx.autointerface easy_install
ou tout autre moyen qui obtient le paquet sur votre PYTHONPATH.
Enregistrement de l'extension
Ajouter repoze.sphinx.autointerface à la liste des extensions dans le conf.py de la documentation Sphinx pour votre produit. E.g .:
extensions = ['sphinx.ext.autodoc',
& Nbsp; »sphinx.ext.doctest ',
& Nbsp; »repoze.sphinx.autointerface ',
& Nbsp;]
en utilisant l'extension
Aux endroits appropriés dans votre document, appelez les autodocs d'interface via:
.. :: Autointerface yourpackage.interfaces.IFoo
Sortie de la directive comprend
& Nbsp; * le nom d'interface pleinement qualifié
& Nbsp; * toutes les interfaces de base
& Nbsp; * l'doctstring partir de l'interface, rendu comme reSTX.
& Nbsp; * les membres de l'interface (méthodes et attributs).
& Nbsp; o Pour chaque attribut, la sortie inclut le nom de l'attribut et sa description.
& Nbsp; o Pour chaque méthode, la sortie inclut le nom de la méthode, sa signature, et son docstring (également rendu comme reSTX)

Ce qui est nouveau dans cette version:.

• compatibilité PyPy.
• la compatibilité de Python 3.2 et versions ultérieures. Merci à Arfrever pour le patch.
• Inclure docs de l'interface sous la directive de automodule. Merci à Laurent Krys pour le patch.

Quoi de neuf dans la version 0.6.2:

• Fix TypeError: objet 'NoneType' ne est pas iterable erreur lors de la génération d'un rendu d'une interface sous Python 2.7.

Ce qui est nouveau dans la version 0.6.1:

• Fix ': membre ordre: bysource' manutention .

Ce qui est nouveau dans la version 0.6:

• gérer correctement ": membres:« valeurs définies explicitement dans le directive.

Quoi de neuf dans la version 0.5:

• Ajout du support pour l'': membre ordre: «drapeau , qui peut prendre l'une des trois valeurs boursières, & quot; & quot ;, alphabétique & quot; & quot ;, GroupWise ou & quot; & quot ;. bysource Par défaut, les membres sont documentés dans & quot; hachage & quot; commande.

Exigences :

• Python
• Sphinx