From 56a00447280a5dc08a55a6f0e2ba0f0a4150609f Mon Sep 17 00:00:00 2001 From: Erik Michaels-Ober Date: Sun, 29 May 2011 10:58:35 -0700 Subject: [PATCH] Add YARD for pretty documentation --- .yardopts | 3 +++ README.md | 2 +- Rakefile | 8 ++++++++ gems.gemspec | 3 ++- 4 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 .yardopts diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..dbcb341 --- /dev/null +++ b/.yardopts @@ -0,0 +1,3 @@ +--markup markdown +- +LICENSE.md diff --git a/README.md b/README.md index c5428a2..997b13e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Installation Documentation ------------- -[http://rdoc.info/gems/gems](http://rdoc.info/gems/gems) [pending] +[http://rdoc.info/gems/gems](http://rdoc.info/gems/gems) Continuous Integration ---------------------- diff --git a/Rakefile b/Rakefile index 1d7aeca..2762450 100644 --- a/Rakefile +++ b/Rakefile @@ -2,3 +2,11 @@ require 'bundler' Bundler::GemHelper.install_tasks + +require 'yard' +namespace :doc do + YARD::Rake::YardocTask.new do |task| + task.files = ['LICENSE.md', 'lib/**/*.rb'] + task.options = ['--markup', 'markdown'] + end +end diff --git a/gems.gemspec b/gems.gemspec index 53f5c74..46c5325 100644 --- a/gems.gemspec +++ b/gems.gemspec @@ -3,8 +3,9 @@ require File.expand_path('../lib/gems/version', __FILE__) Gem::Specification.new do |gem| gem.add_development_dependency 'rake', '~> 0.9' + gem.add_development_dependency 'yard', '~> 0.7' gem.add_runtime_dependency 'faraday', '~> 0.6.1' - gem.add_runtime_dependency 'faraday_middleware', '~> 0.6.4' + gem.add_runtime_dependency 'faraday_middleware', '~> 0.6.3' gem.add_runtime_dependency 'hashie', '~> 1.0.0' gem.add_runtime_dependency 'multi_json', '~> 1.0.3' gem.add_runtime_dependency 'rash', '~> 0.3.0'