sphinxcontrib-coffee

sphinxcontrib-koffie is een Sphinx extensie die een CoffeeScript domein AutoDoc steun aan Sphinx voegt.
Dit is gebaseerd op coffeedoc_ naar bron opmerkingen extraheren uit `` .coffee`` bestanden. Om coffeedoc wereldwijd installeren ::
& Nbsp; npm installeren -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Gebruik
Eerst moet u de extensie toe te voegen aan je lijst met extensies in conf.py:
& Nbsp; extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Omdat Python heeft geen idee over waar je bronnen zijn, moet je het vertellen waar je moet zoeken in je conf.py als volgt:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Tot slot, als uw project is in de eerste plaats CoffeeScript, wilt u misschien het primaire domein en definiëren:
& Nbsp; primary_domain = 'koffie'
Richtlijnen en Rollen
Dit domein biedt module, functie, klasse en wijze richtlijnen, evenals meth, klasse, en func rollen voor kruisverwijzingen. Om te verwijzen naar een ander object, gebruik dan het is volledig gekwalificeerde naam: De module naam, een dubbele dubbele punt en de stip apart pad naar het object binnen de module.
Bijvoorbeeld, om te verwijzen naar de `` swizzle`` functie in het bestand `` lib / widgets.coffee``, schrijf ``: koffie: func: `lib / widgets :: swizzle``. Coffee`` als uw primaire domein is ingesteld op koffie, en u kunt de module naam laten vallen iff u een koppeling vanuit de `` lib / widgets`` module: U kunt de toonaangevende `` dalen.
AutoDoc
U kunt documenteren gehele modules eenvoudig met `` automodule``:
.. Sourcecode :: rst
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : Leden:

Eisen

• Python