Re: [ruby-gnome2-devel-ja] プロジェクトページについて

[Kouhei S. <ko...@co...>]

須藤です。

In <AANLkTikCC+75pdPd=Smv=a_B...@ma...>
  "Re: [ruby-gnome2-devel-ja] プロジェクトページについて" on Thu, 10 Feb 2011 20:24:01 +0900,
  青柳政聡 <mas...@gm...> wrote:

> 英語の方でも酷くなってると指摘されてしまったようなので、リファレンスのyardoc化を
> 先に提案したいと思います。
> 
> rdocではなくyardocなのは、以下のような理由です。
>  * rdocは日本語が通らないことが多く、品質が疑わしい
>  * yardocの方が生成されるドキュメントが見やすい
>  * 今後、形式変更することになったとしてもrdocからyardocよりも逆の方が簡単そう
>  * yardoc自体のドキュメントも、しっかりしている気がする
>
> yardoc化して、http://rubydoc.info/ でリファレンスを置いてもらえば（というか既にありますが）
> cgiを、ほとんど利用する必要がなくなり、Server Errorから開放されそうな気がしますが、
> いかがでしょうか？

RDocよりもYARDの方がよさそうな（気がする）のは私も同じなので
すが、以下の2点が気になっています。

  * 既存のRDのドキュメントの移行はどうするか
  * 国際化（例えば日本語用ドキュメント）に対応できる余地はあるか

このあたりの扱いが難しそうなら、とりあえず、Hikiのコンテンツ
をHTML化してしまうのがよい気もしています。

GNOME3に対応するときに大きく変わる可能性もある(*)ので、大掛か
りな変更になりそうなら、そのタイミングの方がよいのかもしれま
せん。

(*) GObject Introspectionを使うかもとか。


今のタイミングでドキュメントのバックエンドを更新するのと、と
りあえずHikiのコンテンツを静的HTML化しておくのだとどっちがよ
さそうでしょうか？