sphinxcontrib-coffee

sphinxcontrib-kaffe er en Sphinx udvidelse, der tilføjer en CoffeeScript domæne med AutoDoc støtte til Sphinx.
Dette afhænger af coffeedoc_ at udtrække kilde kommentarer fra `` .coffee`` filer. For at installere coffeedoc globalt ::
& Nbsp; NPM installere -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Anvendelse
Først skal du tilføje en udvidelse til din liste over udvidelser i conf.py:
& Nbsp; extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Fordi Python har ingen anelse om, hvor dine kilder er, skal du fortælle det hvor man kan se i din conf.py som så:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Endelig, hvis dit projekt er primært CoffeeScript, kan du definere det primære domæne samt:
& Nbsp; primary_domain = 'kaffe'
direktiver og Roles
Dette domæne indeholder modul, funktion, klasse og metode direktiver samt meth, klasse- og funk roller for krydshenvisninger. For at referere til en anden genstand, brug det fuldt kvalificerede navn: Modulet navn, en dobbelt kolon, og prikken separat sti til objektet i modulet.
For eksempel til at henvise til `` swizzle`` funktion i filen `` lib / widgets.coffee``, skrive ``: kaffe: func: `lib / widgets :: swizzle``. Du kan slippe den førende ``: coffee`` hvis dit primære domæne er indstillet til kaffe, og du kan slippe modulet navn iff du linker inde fra `` lib / widgets`` modul.
AutoDoc
Du kan dokumentere hele moduler nemt med `` automodule``:
.. Kildekode :: rst
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Medlemmer:

Krav :

• Python