repoze.sphinx.autointerface

repoze.sphinx.autointerface περιγράφει μια επέκταση για το σύστημα τεκμηρίωσης Σφίγγα & nbsp?. Η επέκταση επιτρέπει την παραγωγή του API τεκμηρίωση από την ενδοσκόπηση των περιπτώσεων zope.interface στον κώδικα.
Εγκατάσταση:
Εγκατάσταση μέσω easy_install:
bin / 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? O Για κάθε χαρακτηριστικό, η έξοδος περιλαμβάνει το όνομα του χαρακτηριστικού και την περιγραφή του.
& Nbsp? O Για κάθε μέθοδο, η έξοδος περιλαμβάνει το όνομα της μεθόδου, την υπογραφή του, και docstring του (επίσης αποδίδεται ως reSTX)

Τι είναι καινούργιο σε αυτή την έκδοση:.

• συμβατότητα PyPy.
• Python 3.2+ συμβατότητα. Χάρη στην Arfrever για την ενημερωμένη έκδοση κώδικα.
• Συμπεριλάβετε docs διεπαφής σύμφωνα με την οδηγία automodule. Χάρη στην Krys Lawrence για την ενημερωμένη έκδοση κώδικα.

Τι είναι καινούργιο στην έκδοση 0.6.2:

• Fix TypeError: αντικείμενο «NoneType» δεν είναι iterable σφάλμα κατά τη δημιουργία του απόδοση μιας διεπαφής υπό την Python 2.7.

Τι είναι καινούργιο στην έκδοση 0.6.1:

• Fix »: μέλος-παραγγελία: bysource« χειρισμό .

Τι είναι καινούργιο στην έκδοση 0.6:

• Σωστά χειριστεί »: τα μέλη:« οι τιμές καθορίζονται ρητά στην της οδηγίας.

Τι είναι καινούργιο στην έκδοση 0.5:

• Προστέθηκε υποστήριξη για την ": μέλος-παραγγελία:« σημαία , η οποία μπορεί να λάβει μία από τις τρεις τιμές μετοχών, & quot? αλφαβητική & quot ;, & quot? ομαδικώς & quot ;, ή & quot? bysource & quot ;. Από προεπιλογή, τα μέλη τεκμηριώνονται στο & quot? Hash & quot? παραγγελία.

Απαιτήσεις :

• Python
• Σφίγγα