yard-sinatraでSinatraのドキュメントにYARDを使う - Aerialarts
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メソッド順にアクションが並んでいる。
Rails2 で Bundler を使う :: marugoshi.org
Thursday, June 23, 2011 基本的には、 公式ドキュメント にあるやり方でまったく問題ない。 ただ、rake を走らせると以下のような WARNING が出る。 rake/rdoctask is deprecated. Use rdoc/task instead (in RDoc 2.4.2+) rake を 0.8.7 まで下げると動くよ、という記事はたくさん見るんだが、Bundler は rake 0.9.2 に依存しているので無理。 ということで、言われている通りに直せばよい。 $ git diff Rakefile diff --git a/Rakefile b/Rakefile index 3bb0e85..4602927 100644 --- a/Rakefile +++ b/Rakefile @@ -5,6 +5,6 @@ require(File.j
NAMAKESUGI | YARDがすごい
FlexやRuby on Railsなどで使い方とかを自分が後でわかるようにメモしておくブログ。最近はFlex系に飽きてます。 [ruby]rdocは捨て去られてYARDになった[gem] 皆さんはrubyやrailsのドキュメントをどのように作成されていますか？ rdocだとjavadocみたいなことができないーーーということに悩んでいませんか？ そんなときにはこれをお試しください。 yardとは rdocの進化版 すごく綺麗なリファレンスが作成できます 参考URLとしてyardの凄さを表したのがこのページです。 => Gemリファレンス Gemに登録されているライブラリをyardで表示しています。 インストール 今回利用したのは0.6.4です。なおrdocの生成を勝手にしますが、失敗します。 gem install yard ドキュメント生成方法 RAILS等のルートディレクトリで実行
Ruby-Doc.org: Documenting the Ruby Language
Current Ruby Releases These are the complete API documents for base classes, modules, and included libraries in the current stables releases of Ruby. Complete API docs for Ruby 3.3.0 Complete API docs for Ruby 3.2.3 Complete API docs for Ruby 3.1.4 Complete API docs for Ruby 3.0.6 Complete API docs for Ruby 2.7.8 Older Ruby Releases Complete 3.2.2 Complete 3.2.1 Complete 3.2.0 Complete 3.1.2 3.1.1
hannaテンプレートでgemのrdocをスタイリッシュに - レオメモ - s21g
rdocのデフォルトのテンプレートが非常にダサくて、なかなか使いづらい。mislavのhannaを使えば、こんなにスタイリッシュになる： おまけとして、簡単なメソッド検索もできます。また、テンプレート自体はhamlで書いていて、なかなか読みやすい。「スケールできる」ことが売りらしいけど、まぁ意味不明な自慢だよね。 インストール rdoc 2.3.0をインストールする。現在のhannaはまだ最新rdocの2.4.xに対応していないからご注意ください。 1 sudo gem install rdoc -v 2.3 2 <<-- 3 2. githubをgemのsourceに追加 4 shell-unix-generic>> 5 gem source add http://gems.github.com
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - dxw/wpdoc: Standalone sdoc generator
File: README — Documentation for stympy/faker (master)
gitrdoc.com
