sphinxcontrib-coffee

sphinxcontrib-kaffe er en Sphinx utvidelse som legger en CoffeeScript domene med AutoDoc støtte til Sphinx.
Dette er avhengig av coffeedoc_ å trekke kilde kommentarer fra `` .coffee`` filer. Å installere coffeedoc globalt ::
& Nbsp; NPM installere -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Bruk
Først må du legge til forlengelse til din liste over utvidelser i conf.py:
& Nbsp; utvidelser = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Fordi Python har ingen anelse om hvor kildene er, må du fortelle det hvor du skal lete i din conf.py som så:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Til slutt, hvis prosjektet er først og fremst CoffeeScript, kan det være lurt å definere hoveddomenet også:
& Nbsp; primary_domain = "kaffe"
direktiver og roller
Dette domenet gir modul, funksjon, klasse og metode direktiver, samt meth, klasse- og funk roller for kryssreferanser. For å referere til et annet objekt, kan du bruke det er fullt kvalifisert navn: Modulen navn, en dobbel kolon, og prikken egen bane til objektet i modulen.
For eksempel, for å referere til `` swizzle`` funksjon i filen `` lib / widgets.coffee``, skrive ``: kaffe: func: `lib / widgets :: swizzle``. Du kan slippe den ledende ``: coffee`` Hvis primærdomenet er satt til kaffe, og du kan slippe modulnavnet iff du kobler fra i `` lib / widgets`` modul.
AutoDoc
Du kan dokumentere hele moduler lett med `` automodule``:
.. Kildekode :: rst
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Medlemmer:

Krav :

• Python