Skip to content

Commit

Permalink
Fixes #1090 - Removes yard docs
Browse files Browse the repository at this point in the history
- Add link for documentation published by rubygems in README
- Remove rake task to generate YARD docs
- Remove yard and redcardpet gem as a dependency
- Remove .yardopts
- Remove ignoring .yardoc directory
  • Loading branch information
ramkumar-kr committed Oct 7, 2017
1 parent 5808de3 commit bbaf9c6
Show file tree
Hide file tree
Showing 14 changed files with 2 additions and 65 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ pkg
.ruby-version
.ruby-gemset
.bundle
.yardoc/*
.byebug_history
dist
Gemfile.lock
Expand Down
2 changes: 0 additions & 2 deletions .yardopts

This file was deleted.

1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
44 changes: 0 additions & 44 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions gemfiles/multi_json.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/multi_xml.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rack_1.5.2.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rack_edge.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rails_3.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rails_4.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rails_5.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions gemfiles/rails_edge.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bbaf9c6

Please sign in to comment.