Add YARD for pretty documentation

rubygems · May 29, 2011 · 56a0044 · 56a0044
1 parent 982e425
commit 56a0044
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md
diff --git 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
@@ -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
@@ -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'