From 025c413be1d59a235473255ef93caa96f32977f1 Mon Sep 17 00:00:00 2001 From: Ramkumar Date: Thu, 5 Oct 2017 23:09:18 +0530 Subject: [PATCH] Fixes #1090 - Add link for documentation published by rubygems in README - Remove rake task to generate YARD docs --- README.md | 1 + Rakefile | 44 -------------------------------------------- 2 files changed, 1 insertion(+), 44 deletions(-) diff --git a/README.md b/README.md index a7787ea174..67c4bbee3f 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,7 @@ The current stable release is [1.0.1](https://github.com/ruby-grape/grape/blob/v ## Project Resources * [Grape Website](http://www.ruby-grape.org) +* [Documentation](http://www.rubydoc.info/gems/grape) * Need help? Try [Grape Google Group](http://groups.google.com/group/ruby-grape) or [Gitter](https://gitter.im/ruby-grape/grape) * [Follow us on Twitter](https://twitter.com/grapeframework) diff --git a/Rakefile b/Rakefile index 1df4278400..a62ec8562e 100644 --- a/Rakefile +++ b/Rakefile @@ -24,47 +24,3 @@ RuboCop::RakeTask.new task default: [:rubocop, :spec] -begin - require 'yard' - DOC_FILES = ['lib/**/*.rb', 'README.md'].freeze - - YARD::Rake::YardocTask.new(:doc) do |t| - t.files = DOC_FILES - end - - namespace :doc do - YARD::Rake::YardocTask.new(:pages) do |t| - t.files = DOC_FILES - t.options = ['-o', '../grape.doc/docs'] - end - - namespace :pages do - desc 'Check out gh-pages.' - task :checkout do - dir = File.dirname(__FILE__) + '/../grape.doc' - unless Dir.exist?(dir) - Dir.mkdir(dir) - Dir.chdir(dir) do - system('git init') - system('git remote add origin git@github.com:ruby-grape/grape.git') - system('git pull') - system('git checkout gh-pages') - end - end - end - - desc 'Generate and publish YARD docs to GitHub pages.' - task publish: ['doc:pages:checkout', 'doc:pages'] do - Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do - system('git checkout gh-pages') - system('git add .') - system('git add -u') - system("git commit -m 'Generating docs for version #{Grape::VERSION}.'") - system('git push origin gh-pages') - end - end - end - end -rescue LoadError # rubocop:disable Lint/HandleExceptions - # ignore -end