Merge pull request #1688 from ramkumar-kr/publish_docs

Fixes #1090
ruby-grape · Oct 7, 2017 · 401899f · 401899f
2 parents 5cc0858 + bbaf9c6
commit 401899f
Show file tree

Hide file tree

Showing 14 changed files with 2 additions and 65 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,7 +29,6 @@ pkg
 .ruby-version
 .ruby-gemset
 .bundle
-.yardoc/*
 .byebug_history
 dist
 Gemfile.lock

diff --git a/.yardopts b/.yardopts
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 #### Features
 
 * [#1686](https://github.com/ruby-grape/grape/pull/1686): Avoid coercion of a value if it is valid - [@timothysu](https://github.com/timothysu).
+* [#1688](https://github.com/ruby-grape/grape/pull/1688): Removes yard docs - [@ramkumar-kr](https://github.com/ramkumar-kr).
 
 #### Fixes
 

diff --git a/Gemfile b/Gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git 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
@@ -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
diff --git a/gemfiles/multi_json.gemfile b/gemfiles/multi_json.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/multi_xml.gemfile b/gemfiles/multi_xml.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rack_1.5.2.gemfile b/gemfiles/rack_1.5.2.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rack_edge.gemfile b/gemfiles/rack_edge.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rails_3.gemfile b/gemfiles/rails_3.gemfile
@@ -16,10 +16,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rails_4.gemfile b/gemfiles/rails_4.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rails_5.gemfile b/gemfiles/rails_5.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do

diff --git a/gemfiles/rails_edge.gemfile b/gemfiles/rails_edge.gemfile
@@ -15,10 +15,8 @@ group :development do
  gem 'guard'
  gem 'guard-rspec'
  gem 'guard-rubocop'
- gem 'yard'
  gem 'appraisal'
  gem 'benchmark-ips'
- gem 'redcarpet'
 end
 
 group :test do