Re: [ruby-gnome2-devel-ja] リファレンスについて

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

須藤です。

In <CAM...@ma...>
  "[ruby-gnome2-devel-ja] リファレンスについて" on Fri, 16 Sep 2011 20:27:35 +0900,
  Masaaki Aoyagi <mas...@gm...> wrote:

> 以前お伝えしたように、リファレンスにYARDを使用することを提案します。

よいと思います！

> 移行方針としては、
>  * girからYARDドキュメントを自動でソースに埋め込む
> 　その際、todoタグ(fixme)を追加しておく
>  * 英語圏の人を中心に、既存のHikiとソースの内容を踏まえて修正してもらう
> 　修正が完了したらtodoタグを削除する
> というのを考えています。

こちらもそれでよいと思います。
英語圏の人たちに作業の流れを説明するためのドキュメントを用意
したほうがよさそうですね。


それから後の作業になりますが。。。
実は、YARDで英語のドキュメントを作って、それをベースに日本語
など他の言語用のドキュメントも作るためのライブラリを作ってい
ます。
  http://groonga.rubyforge.org/packnga/ja/

使用例:
  http://groonga.rubyforge.org/rroonga/ja/
  http://groonga.rubyforge.org/rroonga/en/

英語のドキュメントがYARDに移行できたら↑を使えるかもです。

（↑を作っていて、やっぱりYARD本体にもI18N関連の機能がないと
厳しいなぁという事がわかったので、今、YARDのMLに行ってそこら
へんを相談していたりします。）


> まだまだ作業中ですが、ある程度ツールを書いたのでプレビュー版？として添付します。
> yagi_gnomeというのが作成したツールで、使い方は、
> 　$ gem install yagi_gnome
> 　$ gem install vte
> 　$ yard config -a autoload_plugins gnome
> 　$ yard server -g
> 　ブラウザから、http://localhost:8808/ にアクセス
> という感じを想定しています。（gemはアップされていないので、添付のものを入れてください）

おぉ！

> ただ、上記の方法はgemインストール時にソースからリファレンスを生成するのですが、
> 以下のような問題があるので、生成済みのドキュメントも配布した方がいいのかなと考えています。
>  * ツールがRuby1.9.2以降しかサポートしない
>  * Windowsの場合、ソースからインストールしないので、リファレンスが生成されないはず
>  * メソッドの数が多いと表示が遅い（うちの環境ではVte::Terminalの表示に１０秒程度もかかる）
> 生成したドキュメントのサンプルを、vte-doc.tar.bz2として添付します。
> doc/frames.htmlを開けば見れるはずです。
> 
> いかがでしょうか？

生成したドキュメントは今のHikiを置き換える形でWebに置くのが
よいかと思いました。
全ての環境でドキュメントを生成するのは難しそうなので、デフォ
ルトだとgemインストール時はドキュメント生成はoffにしておいた
方がよさそうですね。そういうことができるかわかっていないので
すが。。。



> それと、添付しちゃいましたが、どこかにファイル置き場みたいなとこがありましたでしょうか？

リポジトリはGitHubのRuby-GNOME2のところに置いちゃっていいと
思います。
  https://github.com/ruby-gnome2

プロジェクト名は「yagi_gnome」でよいですか？であれば、作って
おきますよー あ、あと、青柳さんのGitHubのアカウントを教えて
もらえますか？

ファイル置き場はSF.netのファイルリリースシステムを使うのがい
いと思います。

Webからだと↓からアップロードできると思います。
  https://sourceforge.net/projects/ruby-gnome2/files/

コマンドラインからだとscpとかsftpとかrsyncとかでアクセスでき
ます。例えば、sftpだとこんな感じでいけるはずです。
  % sftp masaakiaoyagi,rub...@fr...:/home/frs/project/r/ru/ruby-gnome2