COPYRIGHT Allison template for RDoc, copyright 2006 Cloudburst, LLC (see the LICENSE file) DETAILED DOCUMENTATION http://blog.evanweaver.com/articles/2006/06/02/allison QUICKSTART The best way to use the template is to set up a Rake task for your Ruby project or Rails app: in Rakefile require 'rake/rdoctask' Rake::RDocTask.new do |rdoc| files = ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc', 'test/*.rb'] rdoc.rdoc_files.add(files) rdoc.main = "README" # page to start on rdoc.title = "My App's Documentation" rdoc.template = "/path/to/allison/allison.rb" rdoc.rdoc_dir = 'doc' # rdoc output folder rdoc.options << '--line-numbers' << '--inline-source' end Then you can run rake rdoc to invoke the task and everything will be super awesome. Note, pop-up source view is not supported. You have to use --inline-source. CHANGELOG 2.2 how come "require_gem" isn't called "activate_gem", since that's what it does. bah. 2.1 hack to make gem versioning work 2. caching in order to remove Markaby dependency 1. first release