[小ネタ]bundlerでインストールしたgemのrdocを読む

bundlerでインストールしたgemのドキュメントを読むためにローカルにインストールしたソースコードからrdocをビルドして表示してみたのでそのメモです。
2020.08.31

はじめに

前回の記事oauth2のドキュメントを読むためにローカルにインストールしたソースコードからrdocをビルドして表示してみたのでそのメモです。

やること

前提として必要なGemはGemfileに定義されているものとします。

必要なのは以下の2つです。

  • rdocの生成
  • gem serverの起動

コマンド

# rdocの生成
$ bundle exec gem rdoc oauth2
Parsing documentation for oauth2-1.4.4
Installing ri documentation for oauth2-1.4.4
# gem serverの起動
$ bundle exec gem server
Server started at http://[::]:8808
Server started at http://0.0.0.0:8808
# ブラウザにアクセスする

ブラウザにアクセスすると以下のようなドキュメントが表示されます。

まとめ

普段は雰囲気でRubyを書いているので基礎的なことを調べるいい機会になりました。