sphinxcontrib-coffee

sphinxcontrib-コーヒースフィンクスにautodocのサポートでCoffeeScriptのドメインを追加してスフィンクスの拡張機能です。
これは `` .coffee``ファイルからソースコメントを抽出するためにcoffeedoc_に依存しています。グローバルcoffeedocをインストールするには::
＆NBSP; NPM -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役割を提供しています。モジュール名、ダブルコロン、およびモジュール内のオブジェクトへのドットの別々のパス：別のオブジェクトを参照するためには、完全修飾名による使用。
たとえば、ファイル `` libに/ widgets.coffee``で `` swizzle``機能を参照するために、 ``書く：コーヒー：FUNC： `LIB /ウィジェット:: swizzle``。プライマリドメインはコーヒーに設定されている、とあなたは `` libに/ widgets``モジュール内からリンクしているときに限り、モジュール名をドロップすることができればcoffee``：あなたは ``大手をドロップすることができます。
のautodocのの
あなたは `` automodule``で簡単に全体のモジュールを文書化することができます。
..ソースコード:: RST
＆NBSP; .. automoduleと::のmymodule
＆NBSP;＆NBSP;＆NBSP; ：メンバー：

の要件の

• のPythonます。