sphinxcontrib-coffee

sphinxcontrib-koffie is 'n Sphinx uitbreiding wat voeg 'n CoffeeScript domein met autodoc ondersteuning aan Sphinx.
Dit berus op coffeedoc_ bron kommentaar te uittreksel uit `` .coffee`` lêers. Coffeedoc wêreldwyd installeer ::
& Nbsp; NPM installeer G coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Gebruik
Eerstens moet jy die uitbreiding voeg tot jou lys van uitbreidings in conf.py:
& Nbsp; uitbreidings = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Omdat Python het geen idee oor waar jou bronne is, moet jy dit vertel waar om te kyk in jou conf.py soos so:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Ten slotte, as jou projek is hoofsaaklik CoffeeScript, wil jy dalk die primêre domein asook om te definieer:
& Nbsp; primary_domain = 'koffie'
Riglyne en rolle
Hierdie domein bied module, funksie, klas en metode riglyne, sowel as meth, klas, en funk rolle vir kruisverwysing. Ten einde 'n ander voorwerp te verwys, gebruik dit ten volle gekwalifiseerde naam: Die module naam, 'n dubbele kolon, en die dot aparte pad na die voorwerp in die module.
Byvoorbeeld, die `` swizzle`` funksie te verwys in die lêer `` lib / widgets.coffee``, skryf ``: koffie: funk: `lib / widgets :: swizzle``. Jy kan drop die voorste ``: coffee`` as jou primêre domein is ingestel op die koffie, en jy kan die module naam drop IFF jy 'n skakel van binne die `` lib / widgets`` module.
Autodoc
Jy kan die hele modules maklik met `` automodule`` dokumenteer:
.. Bronkode :: eerste
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Lede:

Vereistes :

• Python