From 0e8ba5d89541b3998b037359b6f4814cc63f1fc8 Mon Sep 17 00:00:00 2001 From: Mark Lee Date: Tue, 12 Jul 2016 22:22:39 -0700 Subject: [PATCH] Replace RDoc with YARD --- .gitignore | 2 +- .rdoc_options | 24 ------------------------ Rakefile | 6 +++--- thermite.gemspec | 2 +- 4 files changed, 5 insertions(+), 29 deletions(-) delete mode 100644 .rdoc_options diff --git a/.gitignore b/.gitignore index 6caec8a..f9eb49f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ *.gem +.yardoc Gemfile.lock coverage doc -html diff --git a/.rdoc_options b/.rdoc_options deleted file mode 100644 index 64feafa..0000000 --- a/.rdoc_options +++ /dev/null @@ -1,24 +0,0 @@ ---- !ruby/object:RDoc::Options -encoding: UTF-8 -static_path: [] -rdoc_include: -- "lib/thermite/*.rb" -- "README.md" -charset: UTF-8 -exclude: -- vendor/bundle -hyperlink_all: false -line_numbers: true -locale: -locale_dir: locale -locale_name: -main_page: README.md -markup: markdown -output_decoration: true -page_dir: -show_hash: false -tab_width: 2 -template_stylesheets: [] -title: -visibility: :protected -webcvs: https://github.com/malept/thermite/tree/master diff --git a/Rakefile b/Rakefile index 9a4c007..6b98e3c 100644 --- a/Rakefile +++ b/Rakefile @@ -20,14 +20,14 @@ require 'bundler/gem_tasks' require 'rake/testtask' -require 'rdoc/task' require 'rubocop/rake_task' +require 'yard' Rake::TestTask.new do |t| t.libs << 'test' t.test_files = FileList['test/**/*_test.rb'] end -RDoc::Task.new +YARD::Rake::YardocTask.new RuboCop::RakeTask.new -task default: %w(rubocop rdoc test) +task default: %w(rubocop yard test) diff --git a/thermite.gemspec b/thermite.gemspec index 8675a54..5015cc5 100644 --- a/thermite.gemspec +++ b/thermite.gemspec @@ -23,6 +23,6 @@ Gem::Specification.new do |s| s.add_runtime_dependency 'tomlrb', '~> 1.2' s.add_development_dependency 'minitest', '~> 5.9' s.add_development_dependency 'mocha', '~> 1.1' - s.add_development_dependency 'rdoc', '~> 4.2' s.add_development_dependency 'rubocop', '~> 0.41' + s.add_development_dependency 'yard', '~> 0.9' end