From c4e99fd196a8134ec7885bcb227ab2829e46d7c3 Mon Sep 17 00:00:00 2001 From: Zack Hobson Date: Wed, 20 Nov 2013 09:45:55 -0800 Subject: use yard for documentation --- .document | 1 - README.markdown | 2 +- Rakefile | 5 +++++ hcl.gemspec | 1 + 4 files changed, 7 insertions(+), 2 deletions(-) delete mode 100644 .document diff --git a/.document b/.document deleted file mode 100644 index 2a525aa..0000000 --- a/.document +++ /dev/null @@ -1 +0,0 @@ ---files CHANGELOG diff --git a/README.markdown b/README.markdown index b4394d1..bede4f3 100644 --- a/README.markdown +++ b/README.markdown @@ -1,4 +1,4 @@ -# HCl +# Harvest Command Line HCl is a command-line tool for interacting with Harvest time sheets using the [Harvest time tracking API][htt]. diff --git a/Rakefile b/Rakefile index 95e995c..ccfa277 100644 --- a/Rakefile +++ b/Rakefile @@ -12,3 +12,8 @@ task :install do system "gem install hcl-#{HCl::VERSION}.gem" end +require 'yard' +YARD::Rake::YardocTask.new do |t| + t.options = %w[--files CHANGELOG] +end + diff --git a/hcl.gemspec b/hcl.gemspec index 5596e21..ea0610d 100644 --- a/hcl.gemspec +++ b/hcl.gemspec @@ -20,5 +20,6 @@ Gem::Specification.new do |s| s.add_runtime_dependency 'highline' s.add_development_dependency 'shoulda' s.add_development_dependency 'mocha' + s.add_development_dependency 'yard' end -- cgit v1.2.3