[openrtm-users 01510] Experimental documentation tool

[Yosuke Matsusaka]

産総研の松坂です。

RTCに埋め込まれた情報から各種フォーマットでドキュメントを出力するユーティリティを作りました。
https://github.com/yosuke/rtshell/blob/master/rtshell/rtdoc.py

使用例（latex形式でドキュメントを出力）：
rtdoc -f latex /localhost/hostname.host_cxt/Compname0.rtc

後半部分はrtshellのパス名です。
＃ある程度完成したらジェフさんのrtshellに取り込んでもらおうと思っています。

latex以外にもhtmlやreStructuredText形式で出力ができます。

RTC.xmlが付属していないコンポーネントでもそれなりのドキュメントが生成できるので、ドキュメント
作成の労力を減らしたい場合に有効です。

コンフィギュレーションパラメータの説明欄はそのまま生成すると空欄ですが、例えば以下のようにして
プログラム内に埋め込むことができます。

"conf.default.id",   "[your id]@example.com",
"conf.__description__.id",   "アカウントのIDを入力してください",

ポートの説明欄は同様に以下のようにして埋め込んでください（Pythonの例です）。

self._indata = RTC.TimedString(RTC.Time(0,0), "")
self._inport = OpenRTM_aist.InPort("text", self._indata)
self._inport.appendProperty("description", "音声合成するテキストデータです")

まだ出力がいまいち美しくありませんがコツコツ改良していきたいと思います。
こんな機能が欲しい、などのご意見ありましたら教えてください。

-- 
Yosuke Matsusaka, Ph.D  <yosuke.matsusaka ＠ aist.go.jp>
  Interaction Modeling Group /
  National Institute of Advanced Industrial Science and Technology (AIST)
  Tel: 029-862-6726  Web: http://staff.aist.go.jp/yosuke.matsusaka/