2011年10月16日

[ruby-list:48474] [ANN] TmDoc - RubyコードからDocBook文書を作成

はじめまして。takomachanといいます。

TmDocというRubyソースコードからDocBook文書を自動
生成するツールを紹介します。

* TmDocはRubyソフトウェアの保守活動の支援を目的とした自
動文書化ツールです

* ソフトウェア構造の全体の俯瞰(overview)やモジュー
ル/クラス間の関連性といった情報を重視し、
文書とコードとの間を自在に閲覧(ブラウズ)できる
ハイパーテキストシステムを目標としています

* 出力形式としてDocBookを採用することで、
HTML/EPUB/PDF/RTF/ODF等への多彩な出力への対応も可能になります

TmDocは開発の途上にあって現状はベータ版のレベルですが、
とりあえず最低限で必須の機能は実装できたと考えて以下で公開し
ました。
http://www.h6.dion.ne.jp/~machan/tmdoc/index-ja.html
このサイトの出力例では、Ruby組み込みライブラリであるnet/
rexml/webrick
そして単純なRailsアプリ(depot)等から自動生成したHTML/
EPUB文書を閲覧できます。

現状のTmDocにはリンク先の欠落やら表示の誤りといった軽微
な問題は多々ありますが、
処理の途中でコケルような致命的なbugは無いハスです。
感想/改善要望/バグ報告などがあれば嬉しく思います。
なお次のリリースではクラス/メソッド名等に関する索引(index)
の文書化を考えています。


投稿者 xml-rpc : 2011年10月16日 22:45
役に立ちました?:
過去のフィードバック 平均:(0) 総合:(0) 投票回数:(0)
本記事へのTrackback: http://hoop.euqset.org/blog/mt-tb2006.cgi/106929
トラックバック
コメント
コメントする




画像の中に見える文字を入力してください。