Generating Ruby 1.9 RDocs Tip

Justin Reagor — Wed, 28 Nov 2007 11:39:00 -0500

Like many hardcore Ruby hackers, I am completely psyched for this December… Ruby 1.9 will depot to the world, and give us a much needed refresher in the community.

Last night, following RubyInside’s How to Start Playing with Ruby 1.9 Right Now! I was able to have it compiled in no time (after upgrading GNU Bison on Tiger).

So with a brand new programming language refresh your going to need the API docs right? Well, some people are finding problems when generating these new rdoc’s, so I figured I’d have the same problem…. but not quite…

Allison Is Sexy

Using Evan Weaver’s “Allison” RDoc template gem I was able to do a simple generation of the new RDoc’s with his gorgeous template.

First you’ll need the template…

# sudo gem install allison

Then, from within the root level of the Ruby 1.9 trunk source directory (where you built Ruby 1.9) use the allison command like so.

# allison --title 'Ruby 1.9beta' --line-numbers -o new-rdoc

This will place all the new docs into “new-rdoc” directory. You can copy them out to where ever you like afterwards. I stored mine within my /usr/local/ruby1.9b/doc/.

Remember, when compiling 1.9 to configure with prefix=/usr/local/ruby1.9 otherwise you may overwrite your 1.8 installation… and that would make for a bad workday.

Small Issue

I have experienced some error messages coming from Safari 3, that the Allison template’s Javascripts are loading too slowly. Just hitting the “Continue” button will keep them going. I have not tried this in Firefox or any other browser yet… but that would probably fix this small issue.

has_many :thoughts: Tag rdoc

Generating Ruby 1.9 RDocs Tip