Skip to content

Commit bbaf9c6

Browse files
committed
Fixes #1090 - Removes yard docs
- 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
1 parent 5808de3 commit bbaf9c6

14 files changed

+2
-65
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ pkg
2929
.ruby-version
3030
.ruby-gemset
3131
.bundle
32-
.yardoc/*
3332
.byebug_history
3433
dist
3534
Gemfile.lock

.yardopts

Lines changed: 0 additions & 2 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#### Features
44

55
* [#1686](https://github.com/ruby-grape/grape/pull/1686): Avoid coercion of a value if it is valid - [@timothysu](https://github.com/timothysu).
6+
* [#1688](https://github.com/ruby-grape/grape/pull/1688): Removes yard docs - [@ramkumar-kr](https://github.com/ramkumar-kr).
67

78
#### Fixes
89

Gemfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ group :development do
1515
gem 'guard'
1616
gem 'guard-rspec'
1717
gem 'guard-rubocop'
18-
gem 'yard'
1918
gem 'appraisal'
2019
gem 'benchmark-ips'
21-
gem 'redcarpet'
2220
end
2321

2422
group :test do

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ The current stable release is [1.0.1](https://github.com/ruby-grape/grape/blob/v
117117
## Project Resources
118118

119119
* [Grape Website](http://www.ruby-grape.org)
120+
* [Documentation](http://www.rubydoc.info/gems/grape)
120121
* Need help? Try [Grape Google Group](http://groups.google.com/group/ruby-grape) or [Gitter](https://gitter.im/ruby-grape/grape)
121122
* [Follow us on Twitter](https://twitter.com/grapeframework)
122123

Rakefile

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -24,47 +24,3 @@ RuboCop::RakeTask.new
2424

2525
task default: [:rubocop, :spec]
2626

27-
begin
28-
require 'yard'
29-
DOC_FILES = ['lib/**/*.rb', 'README.md'].freeze
30-
31-
YARD::Rake::YardocTask.new(:doc) do |t|
32-
t.files = DOC_FILES
33-
end
34-
35-
namespace :doc do
36-
YARD::Rake::YardocTask.new(:pages) do |t|
37-
t.files = DOC_FILES
38-
t.options = ['-o', '../grape.doc/docs']
39-
end
40-
41-
namespace :pages do
42-
desc 'Check out gh-pages.'
43-
task :checkout do
44-
dir = File.dirname(__FILE__) + '/../grape.doc'
45-
unless Dir.exist?(dir)
46-
Dir.mkdir(dir)
47-
Dir.chdir(dir) do
48-
system('git init')
49-
system('git remote add origin [email protected]:ruby-grape/grape.git')
50-
system('git pull')
51-
system('git checkout gh-pages')
52-
end
53-
end
54-
end
55-
56-
desc 'Generate and publish YARD docs to GitHub pages.'
57-
task publish: ['doc:pages:checkout', 'doc:pages'] do
58-
Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
59-
system('git checkout gh-pages')
60-
system('git add .')
61-
system('git add -u')
62-
system("git commit -m 'Generating docs for version #{Grape::VERSION}.'")
63-
system('git push origin gh-pages')
64-
end
65-
end
66-
end
67-
end
68-
rescue LoadError # rubocop:disable Lint/HandleExceptions
69-
# ignore
70-
end

gemfiles/multi_json.gemfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ group :development do
1515
gem 'guard'
1616
gem 'guard-rspec'
1717
gem 'guard-rubocop'
18-
gem 'yard'
1918
gem 'appraisal'
2019
gem 'benchmark-ips'
21-
gem 'redcarpet'
2220
end
2321

2422
group :test do

gemfiles/multi_xml.gemfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ group :development do
1515
gem 'guard'
1616
gem 'guard-rspec'
1717
gem 'guard-rubocop'
18-
gem 'yard'
1918
gem 'appraisal'
2019
gem 'benchmark-ips'
21-
gem 'redcarpet'
2220
end
2321

2422
group :test do

gemfiles/rack_1.5.2.gemfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ group :development do
1515
gem 'guard'
1616
gem 'guard-rspec'
1717
gem 'guard-rubocop'
18-
gem 'yard'
1918
gem 'appraisal'
2019
gem 'benchmark-ips'
21-
gem 'redcarpet'
2220
end
2321

2422
group :test do

gemfiles/rack_edge.gemfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,8 @@ group :development do
1515
gem 'guard'
1616
gem 'guard-rspec'
1717
gem 'guard-rubocop'
18-
gem 'yard'
1918
gem 'appraisal'
2019
gem 'benchmark-ips'
21-
gem 'redcarpet'
2220
end
2321

2422
group :test do

0 commit comments

Comments
 (0)