Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Switch to YARD.

We already reference rubydoc.info, we use MarkDown and YARD is great!
  • Loading branch information...
commit af5e875702097a893ebf2696d9db1aea124326c3 1 parent 58cfdca
@weppos weppos authored
Showing with 18 additions and 13 deletions.
  1. +4 −1 .gitignore
  2. +12 −10 Rakefile
  3. +2 −2 dnsimple-ruby.gemspec
View
5 .gitignore
@@ -1,4 +1,3 @@
-rdoc
turbulence
.rvmrc
@@ -6,3 +5,7 @@ turbulence
.bundle
pkg/*
Gemfile.lock
+
+# YARD
+.yardoc
+yardoc/
View
22 Rakefile
@@ -12,14 +12,16 @@ RSpec::Core::RakeTask.new do |t|
end
-require 'rdoc/task'
-
-desc 'Generate documentation.'
-RDoc::Task.new do |rdoc|
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = 'DNSimple Ruby'
- rdoc.options << '--line-numbers' << '--inline-source'
- rdoc.rdoc_files.include('README.md')
- rdoc.rdoc_files.include('lib/*.rb')
- rdoc.rdoc_files.include('lib/**/*.rb')
+require 'yard'
+
+YARD::Rake::YardocTask.new(:yardoc) do |y|
+ y.options = ["--output-dir", "yardoc"]
+end
+
+namespace :yardoc do
+ task :clobber do
+ rm_r "yardoc" rescue nil
+ end
end
+
+task :clobber => "yardoc:clobber"
View
4 dnsimple-ruby.gemspec
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
s.require_paths = ['lib']
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
- s.extra_rdoc_files = %w( LICENSE README.md )
+ s.extra_rdoc_files = %w( README.md LICENSE )
s.executables = `git ls-files -- bin/*`.split("\n").collect { |f|
File.basename(f)
}
@@ -27,6 +27,6 @@ Gem::Specification.new do |s|
s.add_development_dependency 'fakeweb', '>= 0'
s.add_development_dependency 'mocha', '>= 0'
s.add_development_dependency 'rspec', '>= 2.0.0'
- s.add_development_dependency 'rdoc', '~> 3.12.0'
+ s.add_development_dependency 'yard', '~> 0.8.2'
s.add_development_dependency 'vcr', '~> 2.2.5'
end
Please sign in to comment.
Something went wrong with that request. Please try again.