sphinxcontrib-coffee

sphinxcontrib-kaffe är en Sphinx förlängning som lägger till en CoffeeScript domän med Autodoc stöd till Sphinx.
Detta bygger på coffeedoc_ att extrahera käll kommentarer från `` .coffee`` filer. För att installera coffeedoc globalt ::
& Nbsp; NPM installera -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Användning
Först måste du lägga till förlängning till din lista över tillägg i conf.py:
& Nbsp; extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Eftersom Python har ingen aning om var dina källor är, måste du tala om det var du ska leta i ditt conf.py som så:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Slutligen, om ditt projekt är främst CoffeeScript, kanske du vill definiera den primära domänen samt:
& Nbsp; primary_domain = "kaffe"
direktiven och roller
Denna domän ger modul, funktion, klass- och metoddirektiv samt meth, klass och funk roller för korsreferenser. För att referera till ett annat objekt, använd det fullt kvalificerat namn: Modulen namn, en dubbel kolon och pricken separat bana till objektet i modulen.
Till exempel, för att referera till `` swizzle`` funktion i filen `` lib / widgets.coffee``, skriver ``: kaffe: funk: `lib / widgets :: swizzle``. Du kan släppa den ledande ``: coffee`` om din primära domän har ställts in på kaffe, och du kan släppa modulnamnet iff du länkar inifrån `` lib / widgets`` modulen.
Autodoc
Du kan dokumentera hela moduler lätt med `` automodule``:
.. Källkod :: rst
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; Medlemmar:

Krav :

• Python