processi

Switched my rufus projects rdoc to the Allison template by Evan Weaver.

The manoeuver simply amounted to

    sudo gem install -y allison

and then setting the “rd.template” in my Rakefiles :

#
# DOCUMENTATION

#ALLISON = `allison --path`
ALLISON = "/Library/Ruby/Gems/1.8/gems/"+
  "allison-2.0.3/lib/allison.rb"

Rake::RDocTask.new do |rd|

    rd.main = "README.txt"

    rd.rdoc_dir = "html/rufus-verbs"

    rd.rdoc_files.include(
        "README.txt", 
        "CHANGELOG.txt", 
        "LICENSE.txt", 
        "CREDITS.txt", 
        "lib/**/*.rb")

    rd.title = "rufus-verbs rdoc"

    rd.options << '-N' # line numbers
    rd.options << '-S' # inline source

    rd.template = ALLISON if File.exist?(ALLISON)
end

(the full Rakefile here)

I tried to derive the path to allison.rb via the `allison --path` but the “.rb” suffix was missing, so I simply put the full path.

Not much work, a nicer view on my doc, got rid of the frames, life in the Ruby ecosystem is good.