From 7e26be50b2956b118328e2e3f69f8043cfb8569a Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 20 Oct 2020 15:17:33 -0700 Subject: Remove the yard task for generating docs If someone wants to generate docs they can just run yard against the repo. This is overengineered Signed-off-by: Tim Smith --- Gemfile | 6 ------ README.md | 1 - Rakefile | 7 ------- 3 files changed, 14 deletions(-) diff --git a/Gemfile b/Gemfile index 229e58b0..f8484424 100644 --- a/Gemfile +++ b/Gemfile @@ -15,12 +15,6 @@ group :development do gem "rubocop-rspec" end -group :docs do - gem "github-markup" - gem "redcarpet" - gem "yard" -end - group :debug do gem "pry" gem "pry-byebug" diff --git a/README.md b/README.md index 80b9c9c3..d0a6d425 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,6 @@ bundle exec rake -T rake build # Build ohai-$VERSION.gem into the pkg directory rake clean # Remove any temporary products rake clobber # Remove any generated files -rake docs # Generate YARD Documentation rake install # Build and install ohai-$VERSION.gem into system gems rake install:local # Build and install ohai-$VERSION.gem into system gems without network access rake release[remote] # Create tag $VERSION and build and push ohai-$VERSION.gem to rubygems.org diff --git a/Rakefile b/Rakefile index 00d67eda..6d6a3a2c 100644 --- a/Rakefile +++ b/Rakefile @@ -25,13 +25,6 @@ rescue LoadError puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed." end -begin - require "yard" - YARD::Rake::YardocTask.new(:docs) -rescue LoadError - puts "yard is not available. bundle install first to make sure all dependencies are installed." -end - task :console do require "irb" require "irb/completion" -- cgit v1.2.1