This post originated from an RSS feed registered with Ruby Buzz by Red Handed. Original Post: [EVALUATION] - E06 - RDOC REFRAMING Feed Title: RedHanded Feed URL: http://redhanded.hobix.com/index.xml Feed Description: sneaking Ruby through the system Latest Ruby Buzz Posts Latest Ruby Buzz Posts by Red Handed Latest Posts From RedHanded

So, ruby-doc has a new layout which is sensational. The pixel kickback to lo-res is almost wtf and it’s a jolly leap ahead.

Okay, well, it’s a good time to rethink our docs then. I don’t like RDoc’s frames, so I’ve been playing with a new RDoc template for Camping which flips classes using JavaScript. It’s kind of weak, but it’s kind of cool, too, I guess. I mean it’s great for packaging with a gem, but you can’t link to a class’ page. And methods don’t fit into the picture yet. (In action.)

To build:

 rdoc -q -t "Camping Documentation" -1 -T extras/flipbook_rdoc.rb \
   README lib/camping-unabridged.rb > doc/index.html

I’m not saying this template is the answer or anything, but it seems like there’s some taboo over RDoc templates (there’s only like three variations of the same template at large) and I’ll just say that this one took an hour or so.