Skip to content
Browse files

+ Yard documentation generation and cleanup

  • Loading branch information...
1 parent eaedc07 commit 0c2970f08f5849f731054918538d89409c992f55 @kschiess committed Mar 7, 2012
Showing with 12 additions and 12 deletions.
  1. +1 −1 .gitignore
  2. +2 −0 Gemfile.lock
  3. +8 −11 Rakefile
  4. +1 −0 procrastinate.gemspec
View
2 .gitignore
@@ -1,4 +1,4 @@
+doc
.yardoc
.bundle
pkg
-rdoc
View
2 Gemfile.lock
@@ -25,6 +25,7 @@ GEM
rspec-mocks (2.7.0)
state_machine (0.9.4)
thor (0.14.6)
+ yard (0.7.5)
PLATFORMS
ruby
@@ -36,3 +37,4 @@ DEPENDENCIES
procrastinate!
rake
rspec
+ yard
View
19 Rakefile
@@ -1,7 +1,7 @@
require "rubygems"
-require "rdoc/task"
require 'rspec/core/rake_task'
require 'rubygems/package_task'
+require 'rake/clean'
desc "Run all tests: Exhaustive."
RSpec::Core::RakeTask.new
@@ -15,19 +15,14 @@ task :stats do
end
end
-# Generate documentation
-RDoc::Task.new do |rdoc|
- rdoc.title = "procrastinate - a framework to run tasks in separate processes."
- rdoc.options << '--line-numbers'
- rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
- rdoc.template = 'direct' # lighter template used on railsapi.com
- rdoc.main = "README"
- rdoc.rdoc_files.include("README", "lib/**/*.rb")
- rdoc.rdoc_dir = "rdoc"
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+ # t.files = ['lib/**/*.rb']
+ # t.options = ['--any', '--extra', '--opts'] # optional
end
desc 'Clear out RDoc'
-task :clean => [:clobber_rdoc, :clobber_package]
+task :clean => [:clobber_package]
# This task actually builds the gem.
task :gem => :spec
@@ -37,3 +32,5 @@ desc "Generate the gem package."
Gem::PackageTask.new(spec) do |pkg|
# pkg.need_tar = true
end
+
+CLEAN << 'doc'
View
1 procrastinate.gemspec
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
s.add_development_dependency('flexmock')
s.add_development_dependency('guard')
s.add_development_dependency('growl')
+ s.add_development_dependency('yard')
end

0 comments on commit 0c2970f

Please sign in to comment.
Something went wrong with that request. Please try again.