Sha256: ddad7a2400dc18fa3c250a21ce1d68515be171deed61ca8dd72492c235441481

Contents?: true

Size: 1.16 KB

Versions: 5

Compression:

Stored size: 1.16 KB

Contents

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

Version data entries

5 entries across 5 versions & 2 rubygems

Version Path
pstuteville-scrubyt-0.4.31 resources/allison/README
ramaze-0.0.7 doc/allison/README
ramaze-0.0.6 doc/allison/README
ramaze-0.0.9 doc/allison/README
ramaze-0.1.0 doc/allison/README