sphinxcontrib-coffee 0.1.0

This extension adds a CoffeeScript domain with autodoc support to Sphinx.<br /><br />This relies on coffeedoc_ to extract source comments from ``.coffee``<br />files. To install coffeedoc globally::<br /><br /> npm install -g coffeedoc<br /><br />.. _coffeedoc: https://github.com/omarkhan/coffeedoc<br /><br />Usage<br />=====<br /><br />First you must add the extension to your list of extensions in conf.py::<br /><br /> extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']<br /><br />Because Python has no clue about where your sources are, you must tell it<br />where to look in your conf.py like so::<br /><br /> coffee_src_dir = os.path.abspath('../')<br /><br />Finally, if your project is primarily CoffeeScript, you might want to<br />define the primary domain as well::

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Coffee Src Dir,  Confpy,  Extensions,  Python,  Sources,  Sphinxcontribcoffeedomain,  Sphinxextautodoc
Users rating:	0/10