Read more

Configuring RubyGems to not install documentation by default

Arne Hartherz
January 12, 2018Software engineer at makandra GmbH

When installing gems, a lot of time is spent building locally installed documentation that you probably never use.

Illustration UI/UX Design

UI/UX Design by makandra brand

We make sure that your target audience has the best possible experience with your digital product. You get:

  • Design tailored to your audience
  • Proven processes customized to your needs
  • An expert team of experienced designers
Read more Show archive.org snapshot

We recommend you disable documentation generation for gem install by default.
Note that Bundler won't install documentation Show archive.org snapshot , so this advice applies only when installing gems manually.

If you don't already have it, create a ~/.gemrc file. The gemrc is a Yaml file, so add the following line to add default switches to the gem command.

gem: --no-document

(If you do not know --no-document: it replaces the legacy switches --no-rdoc --no-ri. Its abbreviated version is -N.)

Read the RubyGems command reference Show archive.org snapshot for more information.

Posted by Arne Hartherz to makandra dev (2018-01-12 10:49)