sphinxcontrib-coffee

  330 downloads
0.2.0 BSD License    
  UNRATED
Sphinx extension to add CoffeeScript support

description

download

specifications

sphinxcontrib-coffee is a Sphinx extension that adds a CoffeeScript domain with autodoc support to Sphinx.

This relies on coffeedoc_ to extract source comments from ``.coffee`` files. To install coffeedoc globally::

  npm install -g coffeedoc

.. _coffeedoc: https://github.com/omarkhan/coffeedoc

Usage

First you must add the extension to your list of extensions in conf.py:

  extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']

Because Python has no clue about where your sources are, you must tell it where to look in your conf.py like so:

  coffee_src_dir = os.path.abspath('../')

Finally, if your project is primarily CoffeeScript, you might want to define the primary domain as well:

  primary_domain = 'coffee'

Directives and Roles

This domain provides module, function, class and method directives, as well as meth, class, and func roles for cross-referencing. In order to reference another object, use it's fully-qualified name: The module name, a double colon, and the dot separate path to the object within the module.

For example, to reference the ``swizzle`` function in the file ``lib/widgets.coffee``, write ``:coffee:func:`lib/widgets::swizzle``. You can drop the leading ``:coffee`` if your primary domain has been set to coffee, and you can drop the module name iff you are linking from within the ``lib/widgets`` module.

Autodoc

You can document entire modules easily with ``automodule``:

.. sourcecode:: rst

  .. automodule:: mymodule
    :members:
read more   
Last updated on May 22nd, 2012

0 User reviews so far.

SUBMIT