I’ve been working hard to improve the Rails API documentation and I’d
like to announce the release of version 2 of Rannotate.My goal is to
emulate (and improve upon) the PHP style online documentation at
www.php.net. I think websites speak louder than words so check out
rannotate in action here:
Rannotate consists of a custom RDoc generator and a Rails application.
The RDoc generator creates a database out of your files and the rails
application generates the documentation you see on the fly, allowing
for searching, user annotations and many more great things to come.
Read more about it here:
I know there are plenty of bugs. I haven’t been able to try it out on
many platforms. I think most things should be working but please
submit bugs and suggestions using the rubyforge trackers.
Coming in following versions:
History - show diffs between different versions of the documentation
to see what changed between versions of a class, module, file,
RSS Feeds - rss feeds for notes for all parts of the documentation
Bug Fixes - lots of them (with your help)
Thanks go to Matias Pelenur for his contributions to this release,
many bug fixes and chunks of code for the search.