sphinxcontrib-coffee

sphinxcontrib-kávé egy Sphinx kiterjesztése, amely hozzáteszi CoffeeScript domain autodoc támogatást Sphinx.
Ez támaszkodik coffeedoc_ kivonat forrás észrevételeit `` .coffee`` fájlokat. Telepíteni coffeedoc globálisan ::
& Nbsp; NPM telepíteni -g coffeedoc
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Használat
Először is le kell hozzáadni a kiterjesztést a fenti kiterjesztések conf.py:
& Nbsp; extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain "]
Mivel Python fogalma sincs arról, hogy hol a forrás, meg kell mondania, hol keressen a conf.py valahogy így:
& Nbsp; coffee_src_dir = os.path.abspath ("../")
Végül, ha a projekt elsősorban CoffeeScript, akkor érdemes lehet meghatározni az elsődleges domain is:
& Nbsp; primary_domain = "kávé"
irányelvek és szerepek
Ez a terület ad modul, függvény, és a módszer irányelvek, valamint a met, osztály, és funkcionális szerepek kereszthivatkozásra. Annak érdekében, hogy hivatkozhat egy másik objektumot, használja ez teljesen minősített neve: A modul neve, egy kettőspont, és a dot külön utat, hogy az objektum a modulon belül.
Például, hogy hivatkozzon az `` swizzle`` funkciókról a fájl `` lib / widgets.coffee``, levelet ``: coffee: funk: `lib / kütyü :: swizzle``. Akkor csepp vezető ``: coffee``, ha az elsődleges domain van állítva, hogy a kávé, és akkor dobd ki a modul neve IFF fiókot kapcsolni belül a `` lib / widgets`` modul.
Autodoc
Akkor a dokumentum teljes modulok egyszerűen `` automodule``:
.. :: Sourcecode első
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Tag:

követelmények :

• Python