sphinxcontrib-coffee

sphinxcontrib-caffè è un'estensione Sfinge che aggiunge un dominio CoffeeScript con supporto autodoc di Sphinx.
Questo si basa su coffeedoc_ per estrarre commenti origine da `` file .coffee``. Per installare coffeedoc globalmente ::
& Nbsp; NPM installare coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Utilizzo
In primo luogo è necessario aggiungere l'estensione alla tua lista di estensioni in conf.py:
& Nbsp; Estensioni = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Perché Python non ha alcun indizio su dove le sorgenti sono, bisogna dirgli dove andare a cercare nel vostro conf.py in questo modo:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Infine, se il progetto è principalmente CoffeeScript, si potrebbe voler definire il dominio primario pure:
& Nbsp; primary_domain = 'caffè'
direttive e ruoli
Questo dominio fornisce direttive moduli, funzioni, classi e metodi, così come meth, di classe, e ruoli func per riferimenti incrociati. Al fine di riferimento a un altro oggetto, usarlo è nome completo: Il nome del modulo, un doppio due punti, e il percorso separato punto per l'oggetto all'interno del modulo.
Ad esempio, per fare riferimento al `` funzione swizzle`` nel file `` lib / widgets.coffee``, scrivere ``: il caffè: func: `lib / widget :: swizzle``. È possibile eliminare la principale ``: coffee`` se il dominio primario è stato impostato per il caffè, e si può cadere il nome del modulo se e solo se si collega dall'interno del / modulo widgets`` `` lib.
Autodoc
È possibile documentare interi moduli facilmente con `` automodule``:
.. :: Sorgente prima
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Membri:

Requisiti :

• Python