Using --no-rdoc and --no-ri with bundler

Question

When using gem install gem_name I can pass --no-rdoc and --no-ri switches to skip generating RDoc/RI documentation for the gem on install.

Is there a similar way to do this with bundle install?

As explained by Timbinous (2nd most voted answer), Bundler does this by DEFAULT — Cec, Aug 19 '16 at 08:17

score 268 · Answer 1 · answered Sep 26 '13 at 20:44

268

Bundler doesn't include rdoc and ri. There is nothing you need to do.

answered Sep 26 '13 at 20:44

Timbinous

14

So I see I'm downvoted 5 times. Can anyone explain how I am wrong? Bundler does not include RDoc and RI files when you install gems using `bundle install`. People wanted this as a feature to allow you to install the documentation but they just don't allow it. – Timbinous Sep 12 '14 at 09:11
19

Timbinous [is right](https://github.com/bundler/bundler/issues/383). It is not only correct, it should be the accepted answer because it actually answers the question. Damn shame people are herd-downvoting a correct answer when they know nothing. – p4sh4 Feb 10 '15 at 03:51
15

Just so I'm clear Cyril. When he asks is there a similar way to do this with bundle install? Telling him that bundler already does this for you by default is not actually solving his problem. He never had a problem to begin with. I was telling him that. – Timbinous Feb 16 '15 at 03:37

score 160 · Accepted Answer · answered Sep 23 '11 at 23:12

160

Make a file ~/.gemrc and put this in it:

gem: --no-rdoc --no-ri

That should make it apply whenever you run the gem command. (Even from bundle install)

answered Sep 23 '11 at 23:12

Mitch Dempsey

should it be `gem: --no-rdoc --no-ri` or `:gem: --no-rdoc --no-ri`? – deb Sep 23 '11 at 23:15
I copied and pasted what I have in my file, and that has been working for me for a while – Mitch Dempsey Sep 23 '11 at 23:16
Order doesn't matter, btw. It's a list of command line flags to pass to gem. – docwhat Feb 11 '12 at 20:46
2

the updated config is `--no-document` https://www.ruby-lang.org/en/news/2018/12/25/ruby-2-6-0-released/ https://guides.rubygems.org/rubygems-basics/ – buncis Aug 04 '21 at 11:10

score 18 · Answer 3 · edited May 23 '17 at 12:34

18

install: --no-rdoc --no-ri 
update:  --no-rdoc --no-ri

edited May 23 '17 at 12:34

Community

answered Sep 09 '12 at 04:06

David J.

thisismydesign · Answer 4 · 2019-07-15T07:36:02.643

18

The up-to-date setting for ~/.gemrc is

gem: --no-document

But as pointed out, this is already bundler's default.

edited Jul 15 '19 at 07:36

answered Jun 23 '19 at 20:06

thisismydesign

Works with gem 2.x – Kris Aug 13 '19 at 13:09
2

Since Ruby 2.5 ["Merge RubyGems 3.0.1. The --ri and --rdoc options have been removed. Please use the --document and --no-document options instead."](https://archive.ph/XBiY9). All the other answers are outdated. – Sebastián Palma Mar 08 '22 at 11:21

4 Answers4