From: Eric Hodel <drbrain@...7.net>
Date: 2010-04-19T16:57:59+09:00
Subject: Re: Documenting Rakefile using rdoc

On Apr 17, 2010, at 00:34, Jean-Julien Fleck wrote:
> Does anybody know a gem that could be used to document a Rakefile the
> way rdoc does ?
> 
> I've got a Rakefile full of tasks but only a few of them have a 'desc'
> keyword in order to keep 'rake -T' readable. I would like to have an
> html output of the list of all available tasks using the description
> given in the comments above each task, the same way rdoc does for the
> methods of a class. Is there an easy way to do it or special options
> to give to rdoc ? (a plain 'rdoc Rakefile' produce something that is
> unreadable)

I started on a Rakefile parser for RDoc but haven't finished it.  Part of the problem is the rake tasks look bolted on to the side of RDoc.  The other part of the problem is RDoc's Ruby parser is pretty crappy (if you want it to run in 1.8 and 1.9).

Check it out:

  gem install rdoc-rake