sphinxcontrib-coffee

sphinxcontrib-καφέ είναι μια επέκταση Σφίγγα που προσθέτει ένα πεδίο CoffeeScript με την υποστήριξη AutoDoc να Σφίγγα.
Αυτό βασίζεται στην coffeedoc_ να εξαγάγετε τα σχόλια πηγή από `` .coffee`` αρχεία. Για να εγκαταστήσετε coffeedoc παγκοσμίως ::
& Nbsp? ΝΡΜ εγκατάσταση -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Χρήση
Πρώτα πρέπει να προσθέσετε την επέκταση στη λίστα των επεκτάσεων σε conf.py:
& Nbsp? επεκτάσεις = ['sphinx.ext.autodoc »,« sphinxcontrib.coffeedomain »]
Επειδή η Python δεν έχει καμία ένδειξη για το πού είναι οι πηγές σας, πρέπει να το πω, όπου και να κοιτάξει σε conf.py σας αρέσει έτσι:
& Nbsp? coffee_src_dir = os.path.abspath ('../ »)
Τέλος, αν το έργο σας είναι πρωτίστως CoffeeScript, ίσως να θέλετε να ορίσετε τον κύριο τομέα, καθώς και:
& Nbsp? primary_domain = «καφές»
Οδηγίες και Ρόλοι
Αυτός ο τομέας παρέχει ενότητα, τη λειτουργία, την τάξη και τη μέθοδο των οδηγιών, καθώς και μεθ, τάξη, και λει ρόλους για διασταύρωση. Για να αναφερθεί σε κάποιο άλλο αντικείμενο, το χρησιμοποιούν είναι πλήρως αναγνωρισμένο όνομα: το όνομα της ενότητας, ένα διπλό του παχέος εντέρου, και η τελεία ξεχωριστή διαδρομή για το αντικείμενο μέσα στη μονάδα.
Για παράδειγμα, για την αναφορά του `` swizzle`` λειτουργία στο αρχείο `` lib / widgets.coffee``, γράψτε ``: καφές: func: `lib / widgets :: swizzle``. Μπορείτε να ρίξετε την ηγετική ``: coffee`` αν πρωτογενή τομέα σας έχει οριστεί σε καφέ, και μπορείτε να αφήσετε το όνομα της ενότητας αν και μόνο αν είστε σύνδεση μέσα από το `` lib / widgets`` μονάδα.
AutoDoc
Μπορείτε να τεκμηριώσετε ολόκληρο ενότητες εύκολα με `` automodule``:
.. :: Πηγαίο κώδικα RST
& Nbsp? .. :: Automodule mymodule
& Nbsp? & Nbsp? & Nbsp? : Μέλη:

Απαιτήσεις :

• Python