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中