| SPHINXCONTRIB-COFFE SPHINX-extensie Om Coffeescript-ondersteuning toe te voegen |
Download nu |
SPHINXCONTRIB-COFFE Rangschikking & Samenvatting
- Naam uitgever:
- Stephen Sugden
SPHINXCONTRIB-COFFE Tags
SPHINXCONTRIB-COFFE Beschrijving
SPHINXCONTRIB-COFFE is een SPHINX-extensie die een Coffeescript-domein toevoegt met AutoDoc-ondersteuning aan Sfinx.Deze is afhankelijk van Coffeedoc_ om bronopmerkingen van `` .coffee`-bestanden te extraheren. Om Credeedoc wereldwijd te installeren :: NPM Installeer -G Coffeedoc .. _coffeedoc: https://github.com/omarkhan/coffeedocusageFirst U moet de extensie toevoegen aan uw lijst met extensies in Conf.py: Extensions = Omdat Python geen idee heeft over waar uw bronnen zijn, moet u het vertellen waar u in uw Conf.py wilt kijken: Coffee_SRC_DIR = OS.PATH.ABSPATH (' ../ ') Eindelijk Als uw project voornamelijk coffeescript is, wilt u misschien ook het primaire domein definiëren: primair_domain = 'Coffee'Directives en RolestHis-domein biedt module, functie, klasse en methode-richtlijnen, evenals meth, klasse en func-rollen voor kruising referenties. Om een ander object te verwijzen, gebruikt u deze volledig gekwalificeerde naam: de naam van de module, een dubbele dikke dubbele punt en het punt afzonderlijk pad naar het object in de module. Voorbeeld, om te verwijzen naar de "Swizzle`-functie in het bestand` `lib / widgets.coffee`, schrijven` `: Coffee: FUNC:` lib / widgets :: swizzle`. U kunt de toonaangevende ``: koffie "laten vallen als uw primaire domein is ingesteld op koffie, en u kunt de module-naam laten vallen als u vanuit de` `lib / widgets` wordt gekoppeld ,.Autodocyou kan gemakkelijk volledige modules kunnen documenteren Met `` Automodule``: .. Sourcecode :: RST .. Automodule :: MyModule: Leden: Homepage van het product
SPHINXCONTRIB-COFFE Gerelateerde software