Update YARD task
This commit is contained in:
parent
023b927569
commit
c56c9b7729
|
@ -39,7 +39,7 @@ Ideally, a bug report should include a pull request with failing specs.
|
|||
7. Run `open coverage/index.html`. If your changes are not completely covered
|
||||
by your tests, return to step 3.
|
||||
8. Add documentation for your feature or bug fix.
|
||||
9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
|
||||
9. Run `bundle exec rake yard`. If your changes are not 100% documented, go
|
||||
back to step 8.
|
||||
10. Add, commit, and push your changes.
|
||||
11. [Submit a pull request.][pr]
|
||||
|
|
14
Rakefile
14
Rakefile
|
@ -7,17 +7,6 @@ RSpec::Core::RakeTask.new(:spec)
|
|||
task :test => :spec
|
||||
task :default => :spec
|
||||
|
||||
namespace :doc do
|
||||
require 'yard'
|
||||
YARD::Rake::YardocTask.new do |task|
|
||||
task.files = ['LICENSE.md', 'lib/**/*.rb']
|
||||
task.options = [
|
||||
'--output-dir', 'doc/yard',
|
||||
'--markup', 'markdown',
|
||||
]
|
||||
end
|
||||
end
|
||||
|
||||
namespace :cache do
|
||||
require 'mlb'
|
||||
desc "Update the teams file cache"
|
||||
|
@ -28,3 +17,6 @@ namespace :cache do
|
|||
end
|
||||
end
|
||||
end
|
||||
|
||||
require 'yard'
|
||||
YARD::Rake::YardocTask.new
|
||||
|
|
|
@ -8,12 +8,15 @@ Gem::Specification.new do |spec|
|
|||
spec.author = "Erik Michaels-Ober"
|
||||
spec.description = %q{MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.}
|
||||
spec.email = 'sferik@gmail.com'
|
||||
spec.files = `git ls-files`.split("\n")
|
||||
spec.files = %w(.yardopts CONTRIBUTING.md LICENSE.md README.md Rakefile mlb.gemspec)
|
||||
spec.files += Dir.glob("lib/**/*.rb")
|
||||
spec.files += Dir.glob("spec/**/*")
|
||||
spec.homepage = 'https://github.com/sferik/mlb'
|
||||
spec.homepage = ['MIT']
|
||||
spec.name = 'mlb'
|
||||
spec.require_paths = ['lib']
|
||||
spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
|
||||
spec.required_ruby_version = '>= 1.9.2'
|
||||
spec.summary = spec.description
|
||||
spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
||||
spec.version = MLB::VERSION
|
||||
|
|
Loading…
Reference in New Issue