また、現在有志の手によりリファレンスマニュアルの整備が進行中です。作業途中の成果物を<URL:http://doc.ruby-lang.org/ja/>から閲覧できます。
ドキュメント
これはありがたい。
Rubyリファレンスマニュアル刷新計画 (通称るりま) のページへようこそ。
本プロジェクトは、Ruby1.8系および1.9系の完全な日本語ドキュメントを作ることを目標にしています。
ReferenceManualRenewalProject - Main - Ruby Issue Tracking System
ざっと静的HTMLドキュメントを生成する流れはこんな感じ。
bitclust の bc-tohtmlpackage.rb で Static HTML を生成できる。
$ wget http://www.ruby-lang.org/ja/man/archive/ruby-refm-1.9.2-dynamic-20101229.tar.bz2
$ tar xvf ./ruby-refm-1.9.2-dynamic-20101229.tar.bz2
$ cd ruby-refm-1.9.2-dynamic-20101229/
$ ruby ./bitclust/tools/bc-tohtmlpackage.rb -d ./db-1_8_7 -o ./html/1_8_7 --catalog=bitclust/data/bitclust/catalog
$ ruby ./bitclust/tools/bc-tohtmlpackage.rb -d ./db-1_9_2 -o ./html/1_9_2 --catalog=bitclust/data/bitclust/catalog
以下、生成手順のちょっと細かい流れ。
まずは、「Rubyリファレンスマニュアル刷新計画 パッケージ版 1.8.7/1.9.2用 (tar.bz2形式)」をダウンロードしてファイルを展開。
$ wget http://www.ruby-lang.org/ja/man/archive/ruby-refm-1.9.2-dynamic-20101229.tar.bz2
$ tar xvf ./ruby-refm-1.9.2-dynamic-20101229.tar.bz2
$ cd ruby-refm-1.9.2-dynamic-20101229/
$ ls -la
合計 1524
drwxr-xr-x 5 hoge1 hoge1 4096 2010-12-29 22:22 .
drwxr-xr-x 3 hoge1 hoge1 4096 2011-01-28 22:39 ..
drwxr-xr-x 9 hoge1 hoge1 4096 2010-12-29 22:20 bitclust
drwxr-xr-x 7 hoge1 hoge1 4096 2010-12-29 22:21 db-1_8_7
drwxr-xr-x 7 hoge1 hoge1 4096 2010-12-29 22:22 db-1_9_2
-rw-r--r-- 1 hoge1 hoge1 976 2010-12-29 22:22 readme.html
-rwxr-xr-x 1 hoge1 hoge1 98 2010-12-29 22:22 refe-1_8_7
-rw-r--r-- 1 hoge1 hoge1 102 2010-12-29 22:22 refe-1_8_7.cmd
-rwxr-xr-x 1 hoge1 hoge1 98 2010-12-29 22:22 refe-1_9_2
-rw-r--r-- 1 hoge1 hoge1 102 2010-12-29 22:22 refe-1_9_2.cmd
-rw-r--r-- 1 hoge1 hoge1 1503232 2010-12-29 22:20 server.exe
-rw-r--r-- 1 hoge1 hoge1 5724 2010-12-29 22:20 server.exy
-rwxr-xr-x 1 hoge1 hoge1 316 2010-12-29 22:22 server.rb
bitclust に同梱されている bc-tohtmlpackage.rb を使って Ruby 1.8.7 のドキュメントを生成する。
$ ruby ./bitclust/tools/bc-tohtmlpackage.rb -d ./db-1_8_7 -o ./html/1_8_7 --catalog=bitclust/data/bitclust/catalog
mkdir -p ./html/1_8_7
0/13265 done
100/13265 done
200/13265 done
300/13265 done
(中略)
13100/13265 done
13200/13265 done
0 done
100 done
200 done
300 done
400 done
500 done
600 done
700 done
800 done
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7/library/index.html ... done.
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7/class/index.html ... done.
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7/function/index.html ... done.
cp -p /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/style.css /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7
cp -p /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/rurema.png /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7
cp -rp /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/images /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_8_7
bitclust に同梱されている bc-tohtmlpackage.rb を使って Ruby 1.9.2 のドキュメントを生成する。
$ ruby ./bitclust/tools/bc-tohtmlpackage.rb -d ./db-1_9_2 -o ./html/1_9_2 --catalog=bitclust/data/bitclust/catalog
mkdir -p ./html/1_9_2
0/13084 done
100/13084 done
200/13084 done
300/13084 done
(中略)
12700/13084 done
12800/13084 done
12900/13084 done
13000/13084 done
0 done
100 done
200 done
300 done
400 done
500 done
600 done
700 done
800 done
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2/library/index.html ... done.
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2/class/index.html ... done.
creating /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2/function/index.html ... done.
cp -p /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/style.css /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2
cp -p /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/rurema.png /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2
cp -rp /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/bitclust/theme/default/images /home/hoge1/hoge2/ruby-refm-1.9.2-dynamic-20101229/html/1_9_2
できあがったドキュメントの存在を確認。
$ ls -la
合計 1528
drwxr-xr-x 6 hoge1 hoge1 4096 2011-01-28 22:40 .
drwxr-xr-x 3 hoge1 hoge1 4096 2011-01-28 22:39 ..
drwxr-xr-x 9 hoge1 hoge1 4096 2010-12-29 22:20 bitclust
drwxr-xr-x 7 hoge1 hoge1 4096 2010-12-29 22:21 db-1_8_7
drwxr-xr-x 7 hoge1 hoge1 4096 2010-12-29 22:22 db-1_9_2
drwxr-xr-x 4 hoge1 hoge1 4096 2011-01-28 22:48 html
-rw-r--r-- 1 hoge1 hoge1 976 2010-12-29 22:22 readme.html
-rwxr-xr-x 1 hoge1 hoge1 98 2010-12-29 22:22 refe-1_8_7
-rw-r--r-- 1 hoge1 hoge1 102 2010-12-29 22:22 refe-1_8_7.cmd
-rwxr-xr-x 1 hoge1 hoge1 98 2010-12-29 22:22 refe-1_9_2
-rw-r--r-- 1 hoge1 hoge1 102 2010-12-29 22:22 refe-1_9_2.cmd
-rw-r--r-- 1 hoge1 hoge1 1503232 2010-12-29 22:20 server.exe
-rw-r--r-- 1 hoge1 hoge1 5724 2010-12-29 22:20 server.exy
-rwxr-xr-x 1 hoge1 hoge1 316 2010-12-29 22:22 server.rb
$ ls -la ./html/1_8_7/
合計 264
drwxr-xr-x 8 hoge1 hoge1 4096 2011-01-28 22:44 .
drwxr-xr-x 4 hoge1 hoge1 4096 2011-01-28 22:48 ..
drwxr-xr-x 2 hoge1 hoge1 114688 2011-01-28 22:44 class
drwxr-xr-x 2 hoge1 hoge1 4096 2011-01-28 22:40 doc
drwxr-xr-x 2 hoge1 hoge1 36864 2011-01-28 22:44 function
drwxr-xr-x 2 hoge1 hoge1 4096 2011-01-28 22:44 images
-rw-r--r-- 1 hoge1 hoge1 92 2011-01-28 22:44 index.html
drwxr-xr-x 2 hoge1 hoge1 20480 2011-01-28 22:44 library
drwxr-xr-x 989 hoge1 hoge1 57344 2011-01-28 22:44 method
-rw-r--r-- 1 hoge1 hoge1 175 2010-12-29 22:20 rurema.png
-rw-r--r-- 1 hoge1 hoge1 4297 2010-12-29 22:20 style.css
$ ls -la ./html/1_9_2/
合計 252
drwxr-xr-x 8 hoge1 hoge1 4096 2011-01-28 22:53 .
drwxr-xr-x 4 hoge1 hoge1 4096 2011-01-28 22:48 ..
drwxr-xr-x 2 hoge1 hoge1 106496 2011-01-28 22:53 class
drwxr-xr-x 2 hoge1 hoge1 4096 2011-01-28 22:48 doc
drwxr-xr-x 2 hoge1 hoge1 36864 2011-01-28 22:53 function
drwxr-xr-x 2 hoge1 hoge1 4096 2011-01-28 22:53 images
-rw-r--r-- 1 hoge1 hoge1 92 2011-01-28 22:53 index.html
drwxr-xr-x 2 hoge1 hoge1 20480 2011-01-28 22:53 library
drwxr-xr-x 868 hoge1 hoge1 53248 2011-01-28 22:52 method
-rw-r--r-- 1 hoge1 hoge1 175 2010-12-29 22:20 rurema.png
-rw-r--r-- 1 hoge1 hoge1 4297 2010-12-29 22:20 style.css
生成したドキュメント(オブジェクト指向スクリプト言語 Ruby リファレンスマニュアル)はいちおうネットワーク的に近いところに置いておきたいので以下の NI-Lab. - docs collection の下に置いておく。
⇒ Ruby1.8.7
⇒ Ruby1.9.2
ライセンスについては「リファレンスマニュアルについては「配布条件」やウェブインターフェイスのフッターを参照してください」と書いてあった。
Creative Commons - Attribution 3.0 Unported - CC BY 3.0 らしいけど、コピーライトは「Rubyリファレンスマニュアル刷新計画 (通称るりま)」でいいのかな。
あと、たくさんのバージョンのドキュメントが揃ってて1日1回更新しているらしいサイトがあったりする。
What's this
Ruby リファレンスマニュアル刷新計画 の成果物を簡単に見られるようにしています。 詳細はるりまWikiを参照してください。
Information
このサービスは okkez が個人的に自宅のサーバで提供しているものです。 時々、落ちてたりエラーが出ていたりしますが、そういうものです。 連絡をいただければ、速やかに復旧したいとは思っています。 また、予告無く色々実験し始めることもあります。 更新情報やサーバのメンテナンス情報はブログや Twitter を参照してください。
Ruby reference manual (beta)
Ref.
-Ruby Reference Manual
-Ruby reference manual (beta)
-Rubyリファレンスマニュアル刷新計画
tags: Ruby zurazure
Posted by NI-Lab. (@nilab)
