Skip to content

Commit

Permalink
Add Yard for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tomeric committed Apr 3, 2012
1 parent 58042fc commit 5e83a2b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .yardopts
@@ -0,0 +1,3 @@
--readme README.md
--charset utf-8
'lib/**/*.rb' - '*.md'
4 changes: 4 additions & 0 deletions Gemfile
Expand Up @@ -7,6 +7,9 @@ gemspec
group :development do
gem 'rake'

# Documentation:
gem 'yard'

# Testing libraries:
gem 'rspec'
gem 'vcr'
Expand All @@ -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'
Expand Down
5 changes: 5 additions & 0 deletions Guardfile
Expand Up @@ -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.