sphinxcontrib-coffee

sphinxcontrib咖啡是獅身人面像的擴展，增加了與以獅身人面像車博士支持CoffeeScript的域。
這依賴於coffeedoc_從``.coffee``文件中提取源代碼註釋。在全球範圍內安裝coffeedoc ::
＆NBSP;故宮安裝-g coffeedoc
.. _coffeedoc：https://github.com/omarkhan/coffeedoc
用法
首先，你必須添加擴展您的conf.py擴展名列表：
＆NBSP;擴展= ['sphinx.ext.autodoc'，'sphinxcontrib.coffeedomain']
因為Python有沒有線索在哪裡你的來源是，你必須告訴它到哪裡尋找你的conf.py像這樣：
＆NBSP; coffee_src_dir = os.path.abspath則（'../'）
最後，如果你的項目主要是CoffeeScript的，你可能要定義的主域，以及：
＆NBSP; primary_domain ='咖啡'
指令和角色
這一領域提供模塊，函數，類和方法的指令，以及甲基，階級和FUNC角色交叉引用。為了引用另一個對象，使用它的完全限定名稱：模塊名稱，一個雙冒號和點獨立路徑模塊內的對象。
例如，要引用``swizzle``功能的文件``LIB / widgets.coffee``，寫``在：咖啡：FUNC：`lib中/小部件:: swizzle``。你可以將領先的``：coffee``如果你的主域名已經被設置為咖啡，你可以刪除的模塊名稱當且僅當您從``的lib / widgets``模塊內的鏈接。
車博士
您可以輕鬆地記錄與``automodule``整個模塊：
..源代碼::第一個
＆NBSP; .. automodule :: MyModule的
＆NBSP;＆NBSP;＆NBSP; ：成員：

要求：

• 在Python中