Browse files

Add Yard for documentation

  • Loading branch information...
1 parent 58042fc commit 5e83a2bef3f68c50bd203cd769513cc09f5f8c69 @tomeric tomeric committed Apr 3, 2012
Showing with 12 additions and 0 deletions.
  1. +3 −0 .yardopts
  2. +4 −0 Gemfile
  3. +5 −0 Guardfile
View
3 .yardopts
@@ -0,0 +1,3 @@
+--readme README.md
+--charset utf-8
+'lib/**/*.rb' - '*.md'
View
4 Gemfile
@@ -7,6 +7,9 @@ gemspec
group :development do
gem 'rake'
+ # Documentation:
+ gem 'yard'
+
# Testing libraries:
gem 'rspec'
gem 'vcr'
@@ -20,6 +23,7 @@ group :development do
gem 'guard'
gem 'guard-bundler'
gem 'guard-rspec'
+ gem 'guard-yard'
gem 'rb-fsevent'
gem 'rb-readline'
gem 'fuubar'
View
5 Guardfile
@@ -9,3 +9,8 @@ guard 'rspec', version: 2, cli: '--format Fuubar --colour' do
watch(%r{^lib/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
watch('spec/spec_helper.rb') { "spec" }
end
+
+guard 'yard', stdout: '/dev/null', stderr: '/dev/null' do
+ watch('README.md')
+ watch(%r{lib/.+\.rb})
+end

0 comments on commit 5e83a2b

Please sign in to comment.