sphinxcontrib-coffee

sphinxcontrib-káva je rozšíření Sphinx, který přidává doménu CoffeeScript s AutoDoc podporu sfinga.
To závisí na coffeedoc_ extrahovat zdrojové připomínky `` .coffee`` soubory. Chcete-li nainstalovat coffeedoc globálně ::
& Nbsp; NPM nainstalovat -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Použít
Nejprve musíte přidat rozšíření do svého seznamu rozšíření v conf.py:
& Nbsp; rozšíření = ['sphinx.ext.autodoc "," sphinxcontrib.coffeedomain']
Vzhledem k tomu, Python nemá ponětí o tom, kde se vaše zdroje jsou, je třeba ho tam, kde hledat v conf.py jako tak říct:
& Nbsp; coffee_src_dir = os.path.abspath ("../")
A konečně, pokud váš projekt je primárně CoffeeScript, možná budete chtít definovat primární domény také:
& Nbsp; primary_domain = "káva"
směrnice a role
Tato doména obsahuje pokyny modulu, funkce, třídy a metody, stejně jako pervitin, třída, a FUNC role pro porovnání. Aby bylo možné odkazovat na jiný objekt, použijte to je úplný název: název modulu, dvojitá dvojtečka a tečka samostatná cesta k objektu je v rámci modulu.
Chcete-li například odkaz na `` swizzle`` funkci v souboru `` lib / widgets.coffee``, psát ``: káva: FUNC: `lib / widgets :: swizzle``. Lze zrušit vedoucí ``: coffee``, pokud vaše primární doména nastavena na kávu, a vy můžete přetáhnout název modulu, právě jste propojení ze v `` lib / widgets`` modulu.
AutoDoc
Můžete zdokumentovat celý moduly snadno se `` automodule``:
.. Zdrojové kódy :: rst
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Uživatelé:

Požadavky na :

• Python