bin/allison lib/allison.css lib/allison.js lib/allison.rb @@ -1,12 +1,12 @@ -v3.0. Blue branch visual redesign becomes trunk. +v2.0. Blue branch visual redesign becomes trunk. -v2.3. RDoc. +v1.5. RDoc. -v2.2. Again. +v1.4. Again. -v2.1. Hack to make gem versioning work. +v1.3. Hack to make gem versioning work. -v2. Caching in order to remove Markaby dependency. +v1.2. Caching in order to remove Markaby dependency. v1. First release. CHANGELOG @@ -1,23 +1,23 @@ -cache/URL -cache/STYLE -cache/SRC_PAGE -cache/METHOD_LIST -cache/METHOD_INDEX -cache/JAVASCRIPT -cache/INDEX -cache/IMGPATH -cache/FR_INDEX_BODY -cache/FONTS -cache/FILE_PAGE -cache/FILE_INDEX -cache/CLASS_PAGE -cache/CLASS_INDEX +bin/allison cache/BODY -allison.rb -allison.js -allison.css -Rakefile -README -Manifest -LICENSE +cache/CLASS_INDEX +cache/CLASS_PAGE +cache/FILE_INDEX +cache/FILE_PAGE +cache/FONTS +cache/FR_INDEX_BODY +cache/INDEX +cache/JAVASCRIPT +cache/METHOD_INDEX +cache/METHOD_LIST +cache/PROJECT +cache/SRC_PAGE +cache/STYLE CHANGELOG +contrib/Rakefile +lib/allison.css +lib/allison.js +lib/allison.rb +LICENSE +Manifest +README Manifest @@ -7,32 +7,39 @@ A modern, pretty RDoc template. Copyright 2007 Cloudburst, LLC. See included LICENSE file. +The public certificate for this gem is at http://rubyforge.org/frs/download.php/25331/evan_weaver-original-public_cert.pem. + = Usage == Installation -Download a tarball from http://rubyforge.org/frs/?group_id=2835 and extract it to somewhere convenient. There is no gem version. + sudo gem install allison + +== Usage + +To use the template, just run <tt>allison</tt> with your normal RDoc options. For example: + + $ allison --title 'My RDoc' --line-numbers --main README --promiscuous * + +Note that some options like <tt>--one-file</tt> and <tt>--diagram</tt> might not work well. == Rake task -The best way to use the template is to set up a Rake task for your Ruby project or Rails app. In your <tt>Rakefile</tt>, add something like: +You can set up a Rake task if you want. First, find the path to your local machine's template by running <tt>allison --path</tt>. Then add something like the following to your <tt>Rakefile</tt>: require 'rake/rdoctask' Rake::RDocTask.new do |rdoc| - files = ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', - 'doc/**/*.rdoc', 'test/*.rb'] + files = ['README', 'LICENSE', 'CHANGELOG', '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.main = "README" + rdoc.title = "My RDoc" + rdoc.template = "/path/to/gems/allison-2.0/lib/allison" + rdoc.rdoc_dir = 'doc' rdoc.options << '--line-numbers' << '--inline-source' end - -Then you can run <tt>rake rdoc</tt> to invoke the task. -Pop-up source view is not supported. You have to use <tt>--inline-source</tt>. +Now you can run <tt>rake rdoc</tt> to invoke the task. = Extras @@ -45,9 +52,7 @@ http://blog.evanweaver.com/files/allison_release.gif If you want to generate documentation for Rails itself, there is a handy trick. Rails’ RDoc tasks obey the <tt>template</tt> environment variable. For instance, to document ActiveRecord with Allison, run: cd vendor/rails/activerecord/ - template='/path/to/allison/allison' rake rerdoc - -The template value should be the full path to the <tt>allison.rb</tt> file, minus the <tt>.rb</tt> (contrary to the Rake task). + template=`allison --path` rake rerdoc == Reporting problems README @@ -9,4 +9,8 @@ Echoe.new('allison') do |p| p.url = 'http://blog.evanweaver.com/pages/code#allison' p.docs_host = 'blog.evanweaver.com:~/www/bax/public/files/doc/' p.rdoc_pattern = /\.rb|^README|^CHANGELOG|^TODO|^LICENSE$/ + p.clean_pattern = /^doc|^pkg/ + p.rdoc_template = File.expand_path(File.dirname(__FILE__) + "/lib/allison") end + +task :"cache/BODY" => [:clean, :doc] # Rebuild the cache before packaging \ No newline at end of file Rakefile allison.css allison.js allison.rb d5c58515cb4a8efddfae06dd38fd005ffba23082 Evan Weaver evan@cloudbur.st http://github.com/fauna/allison/commit/8741e831c6a97cc50e10bfe61171806e06a7c6d8 8741e831c6a97cc50e10bfe61171806e06a7c6d8 2007-11-07T22:03:40-08:00 2007-11-07T22:03:40-08:00 big shuffle, patch up readme c57c0ac5056186e843c53290ccaebcf54d357989 Evan Weaver evan@cloudbur.st