repoze.sphinx.autointerface

repoze.sphinx.autointerface definisce una proroga per il sistema di documentazione Sfinge. & Nbsp; L'estensione permette la generazione di documentazione delle API per l'introspezione di istanze zope.interface nel codice.
Installazione:
Installare via easy_install:
bin / repoze.sphinx.autointerface easy_install
o qualsiasi altro mezzo che ottiene il pacchetto sulla PYTHONPATH.
Registrazione estensione
Aggiungere repoze.sphinx.autointerface all'elenco estensioni nel conf.py della documentazione Sfinge per il prodotto. Per Esempio .:
Estensioni = ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
utilizzando l'estensione
Nei punti appropriati nel documento, chiamare i autodocs interfaccia tramite:
.. :: Autointerface yourpackage.interfaces.IFoo
Uscita dalla direttiva include
& Nbsp; * il nome dell'interfaccia pienamente qualificato
& Nbsp; * tutte le interfacce di base
& Nbsp; * la doctstring dall'interfaccia, reso come reSTX.
& Nbsp; * i membri dell'interfaccia (metodi e attributi).
& Nbsp; o Per ogni attributo, l'output include il nome dell'attributo e la sua descrizione.
& Nbsp; o Per ogni metodo, l'output include il nome del metodo, la sua firma, e la sua docstring (resa anche come reSTX)

Cosa c'è di nuovo in questa versione:.

• compatibilità PyPy.
• Python compatibilità 3.2+. Grazie a Arfrever per la patch.
• Inserisci docs interfaccia ai sensi della direttiva automodule. Grazie a Krys Lawrence per la patch.

Cosa c'è di nuovo nella versione 0.6.2:

• Fix TypeError: oggetto 'NoneType' non è iterabile errore quando si genera un rendering di un'interfaccia in Python 2.7.

Cosa c'è di nuovo nella versione 0.6.1:

• Fix ': membro-ordine: bysource' gestione .

Cosa c'è di nuovo in versione 0.6:

• gestire correttamente ': Membri:' valori esplicitamente impostati nel direttiva.

Cosa c'è di nuovo in versione 0.5:

• Aggiunto il supporto per il ': Stati-ordine:' bandiera , che può assumere uno dei tre valori azionari, & quot; alfabetico & quot ;, & quot; groupwise & quot ;, o & quot; bysource & quot ;. Per impostazione predefinita, i membri sono documentati in & quot; hash & quot; ordine.

Requisiti :

• Python
• Sphinx