omarkhan/coffeedoc — Issue #14: Sphinx integration
Author: grncdr
Created: 2011-12-26 04:35:37+00:00
State: open

Hey this is really cool. I recently created a (hacky and incomplete) Sphinx extension that parses the output of the nodes_to_json.coffee script I snagged from github.com/showell/CoffeeCoffee to add a "coffee" domain to Sphinx with an automodule directive. You can see an example of the [result](betsmartmedia.github.com/Lazorse/#api-documentation) (documenting [this sourcecode])(https://github.com/BetSmartMedia/Lazorse/blob/master/lib/lazorse.coffee). As you can see, it doesn't properly support Sphinx indexing yet, that was going to be my next step before I came across coffeedoc.

Would you be interested in some patches to enable a --json output mode to the ``coffeedoc`` script? With that I could then re-write my Sphinx extension to depend on that output in favour of the AST traversals I'm already doing (which are probably just duplicates of yours). I think Sphinx support would be awesome for a few reasons:

- document multi-language web-apps in one documentation system.
- all the power of restructured text for doc comments.
- ability to use intersphinx to link back and forth between multiple coffeescript (and non-coffeescript) projects.

To be clear: I'm not asking you to do this, just wanted to see if it's something you are interested in collaborating on.