N.Y.Cityのまちかど

この記事は、N.Y.Cityが行った作業のメモです。

Rdocを含め、Ruby周辺環境は頻繁に修正が行われるため、この情報はすぐに陳腐化する可能性があります。

本記事を参考にしていただくのはご自由ですが、内容の正確性に責任は持ちません。アップデートに対応した情報更新も行う予定はありませんのでご注意ください。

RubyプログラマにとってRdocは非常に便利なドキュメント作成ツールです。

自宅PCに最新のRuby環境をインストールしたところ、Rdocのバージョンが1.1.6になっており、Rdocによって生成されるドキュメントのデザインが一新されていました。

ところが、生成したドキュメントを見てみると、「引数」とか「動作」と書かれた文字が本文にかぶってしまっていました。

HTMLソースを調べたところ、この文字は<h1>タグで囲われていました。生成されたドキュメントのcssで<h1>タグのデザイン定義を見てみると25行目から

h1 {
font-size: 300%;
text-shadow: rgba(135,145,135,0.65) 2px 2px 3px;
color: #6C8C22;
}

となっており、大きくなったフォントサイズに対して、行間が不足しているのが原因だと判断しました。

試しに、このcssを以下のように書き換えてみると

h1 {
font-size: 300%;
line-height: 150%;
text-shadow: rgba(135,145,135,0.65) 2px 2px 3px;
color: #6C8C22;
}

見事に表示が改善されました。

このままでは、次にrdocコマンドを実行してドキュメントを生成すると、せっかく修正したものがまた誤ったcssで上書きされてしまうため、テンプレートを直接修正することにした。

rubyのインストールされているディレクトリから、以下のようにディレクトリを探っていく。

(Rubvのインストールされているディレクトリ)\lib\ruby\1.9.1\rdoc\generator\template\darkfish

その中に「rdoc.css」というファイルがあり、これがテンプレートとなっているので、これを複製してバックアップを作ってから（例えばrdoc_buckup.cssと命名)、rdoc.cssを書き換えます。

先ほどと同様に書き換えて保存しておくと、それ以降Rdocによって生成されるドキュメントに反映されます。