summaryrefslogtreecommitdiff
path: root/Rakefile
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-08-23 20:05:11 -0700
committerTim Smith <tsmith@chef.io>2018-08-23 20:05:11 -0700
commit09881f5cec2d6d5951df2e42f8520c088dbcb09d (patch)
tree182e1c1edaa5919a0b152e85845ce7f1fa2ef4a0 /Rakefile
parent8d393010ccdd1589b4d7255c6910501c7501d031 (diff)
downloadchef-09881f5cec2d6d5951df2e42f8520c088dbcb09d.tar.gz
Simplify / fix our yard doc Rake task
We were trying to parse out a readme file that doesn't exist and the license file which produced errors We namespaced the task in a way we don't do anywhere else. This matches our other gems now Tell people to use bundler in the errors instead of gem installing things We required rubygems which is not necessary Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'Rakefile')
-rw-r--r--Rakefile16
1 files changed, 6 insertions, 10 deletions
diff --git a/Rakefile b/Rakefile
index f37bf469f2..f02bbace95 100644
--- a/Rakefile
+++ b/Rakefile
@@ -57,21 +57,17 @@ begin
task.options += ["--display-cop-names", "--no-color"]
end
rescue LoadError
- puts "chefstyle/rubocop is not available. gem install chefstyle to do style checking."
+ puts "chefstyle/rubocop is not available. bundle install first to make sure all dependencies are installed."
end
begin
require "yard"
- DOC_FILES = [ "README.rdoc", "LICENSE", "spec/tiny_server.rb", "lib/**/*.rb" ].freeze
- namespace :yard do
- desc "Create YARD documentation"
+ DOC_FILES = [ "spec/tiny_server.rb", "lib/**/*.rb" ].freeze
- YARD::Rake::YardocTask.new(:html) do |t|
- t.files = DOC_FILES
- t.options = ["--format", "html"]
- end
+ YARD::Rake::YardocTask.new(:docs) do |t|
+ t.files = DOC_FILES
+ t.options = ["--format", "html"]
end
-
rescue LoadError
- puts "yard is not available. (sudo) gem install yard to generate yard documentation."
+ puts "yard is not available. bundle install first to make sure all dependencies are installed."
end