【Ruby】gemインストール時にrdoc・riのドキュメント生成をグローバルに無効化する方法

Rubyのgemインストールは、時に非常に遅く感じることがあります。その最大の原因のひとつがドキュメント生成です。gemをインストールするたびに、コンピュータはそのソースコード全体をスキャンし、rdoc/ri形式のドキュメントを生成する必要があります。

この機能は、オフライン環境でgemのドキュメントを参照したい場合には便利です。ターミナルで gem server を実行し、ブラウザで https://localhost:8808 にアクセスすれば、ローカルのドキュメントを閲覧できます。また、ri コマンドを使えば、ターミナルから直接ドキュメントを検索することも可能です。

しかし、普段から安定したインターネット接続がある環境であれば、ローカルのドキュメントを利用する機会はほとんどないでしょう。そうなると、ドキュメント生成にかかる時間は単なる無駄になってしまいます。

Bundlerを使っている場合は設定不要

すべてのgemをBundler経由でインストールしているのであれば、何もする必要はありません。Bundlerはデフォルトでrdoc/riの生成をスキップしてくれます。

一方、gem コマンドを直接使ってインストールしている場合は、少し設定が必要になります。

インストール時のオプション指定

gem install を実行する際、フラグを渡すことでrdoc/riの生成を無効化できることは、ご存じの方も多いはずです。

gem install honeybadger --no-rdoc --no-ri  # 旧式（非推奨）
gem install honeybadger --no-document      # 新しい方法

~/.gemrcでデフォルト設定にする

毎回フラグを付けるのが面倒な方は、これらのオプションをデフォルトとして設定しましょう。~/.gemrc ファイルに以下の1行を追加するだけでOKです。

gem: --no-document

これで、以降の gem install 実行時には自動的にドキュメント生成がスキップされるようになり、インストールが大幅に高速化されます。

あとからドキュメントが必要になったら？

「キャンプに出かける予定があり、オフラインでも読めるローカルのドキュメントが欲しい」というようなケースでは、自分で後から生成すれば問題ありません。

gem rdoc --all --overwrite # インストール済み全gemのドキュメントを再生成
gem rdoc honeybadger       # 特定のgemだけドキュメントを生成

ただし、全gemのドキュメントを一括で再生成する場合は注意してください。完了までかなりの時間がかかることがあります :)