yard-sinatraでSinatraのドキュメントにYARDを使う

yardのプラグインであるyard-sinatraを使うとSinatraのアクションごとに記述されたyardocからHTMLドキュメントを生成できる。

インストールと設定

yard-sinatraをインストールすれば必要に応じてyardもインストールされる。 ただしyardはデフォルトではプラグインを読み込まないので、読み込むように設定してやる必要がある。

$ gem install yard-sinatra
$ mkdir ~/.yardoc
$ yard config load_plugins true

ドキュメントの生成

$ cd /path/to/sinatra/project
$ yardoc
$ open doc/index.html # OSXでのみ有効

Class Listからアクションが実装されているClassを選択すると、HTTPメソッド順にアクションが並んでいる。