今度からrvmでruby入れるときはdocument忘れないであげたい
ri 使ってないよ chm で決まりでしょという人には無関係な、ものすごく今さらな話。
RVM: Ruby Version Manager - 'rvm docs' - Working with rdoc / yard.
手で作業するときは rvm1 で入れた 1.9.2 を常用してる2んだけど、実は「1.8 のときに超お世話になってた ri で全然ドキュメント見れなくてすげー不便」と思っていた。いろいろ調べて
yri + yard-doc-core gem
にしてたんだけど、実は
rvm docs generate するだけでよかった
ことが発覚。
なんてこった。これで ri の補完も活かせて嬉しい。
以下はこれを調べるきっかけになった Twitter timeline の抜粋。
19:27:23 <shinji_kono> ruby って、perldoc みたいな offline document な
いの?
19:27:47 <_ko1> @shinji_kono rdoc ってやつが(使ったことないですが)
19:30:46 <_ko1> @shinji_kono 私は windows 使ってるので chm ファイルで
見てます
19:39:17 <shinji_kono> 5分で学ぶRubyは書きました。が、Perl の方には
perldoc 使えって書けるんだけど、Ruby は rdoc ってわけにはいかないらし
い。
19:43:17 <nalsh> @shinji_kono 英語でよろしければ rdoc で、これはCソー
スないドキュメントが由来。「るりま」という日本語マニュアルプロジェクト
はそれとは別ってのが日本人にはちょっと複雑ですかね
19:56:08 <shinji_kono> どうも、Core なライブラリのドキュメントは ri で
引っ掛からないみたいだね。
20:01:18 <nalsh> @shinji_kono Ruby をインストールした時に rdoc を入れ
ていないのではないでしょうか
20:16:32 <shinji_kono> 僕の希望としては、ri File.open でなんか出て欲し
いです。
21:15:00 <wtnabe> @shinji_kono 自分もよく分からないんですが ri は 1.9
からあんまり役に立たなくて yri と yard-doc-core gem を使うとよさげな気
がします。この辺、コアな人たちの話題にあまりのぼらない印象。
21:24:11 <noplans> @wtnabe riで困ってないんですが、なんか問題ありまし
たか?
21:25:00 <wtnabe> @noplans うーんrvmで入れた1.9だとriで特にコアのドキュ
メント全然出ないんですよね。だから以前よりだいぶ不便を感じています。
21:27:09 <noplans> @wtnabe ri --list-doc-dirsにないとか、インストール
時にドキュメント入ってないとかですかねい
21:36:01 <wtnabe> rvmでの入れ方を間違ってるのかな
21:38:16 <wtnabe> 正しい方法が分かっていないということか
21:39:12 <wtnabe> http://beginrescueend.com/rubies/docs/ お。
21:40:20 <wtnabe> take a *long* time って言われた。bingo っぽい。
21:40:45 <wtnabe> まぁすでに yard-doc-core gem 使ってるんだけど。
22:14:29 <noplans> @wtnabe rvm でのインストール時に
--enable-install-doc つけるとドキュメント込みでインストールされないで
すかねい
22:23:47 <wtnabe> できてた。なるほど。
rvm install –enable-install-doc でもいいみたいだ。なるほど、いろいろ参考になりました。
※ ふと思ったけどここに出てるの、自分以外みんな大学の人?
Windows の場合
installer - ruby 1.9 ri problem - Stack Overflow
ちなみに Windows には ri 付かないっぽいけど、まぁ Windows なら chm でいいんじゃないすかね。自分は Mac だけど ichm - iChm is a CHM reader for Mac OS X - Google Project Hosting で便利に使ってます。これは複数タブ開けるので、以前ほど chm きらいじゃなくなりました。
myrurema という別解
るりまプロジェクトですね。コード内のコメントからの生成ではないのでラグがある代わりに日本語で読めます。