問題タブ [yard]

私のプロジェクトのREADMEファイルをマークダウンに変換することにしました。そして、ヤードを使用して、ドキュメントが正常にレンダリングされたことを確認しました。そこで、rdiscountをインストールし、READMEをREADME.mdに変更して、次のことを試しました。

それは私に警告を与えました：

だから私は試しました：

同じ問題。ランニング：

もう少し情報を提供します：

テキスタイルを使ってみても同じことが起こります。誰かが問題を再現してみたい場合は、プロジェクトはgithubにあります。ありがとうございました。

serialized_path現在、Yardoc は次のようなドキュメントを生成します: doc/ModuleName.html、doc/ModuleName/ClassName.html、doc/ModuleName/ClassName/method_name.html /ModuleName/index.html doc/ModuleName/ClassName/index.html および doc/ModuleName/ClassName/method_name/index.html

自分の宝石に関するドキュメントを見たい場合は、次のことができます。

Rubyの標準ライブラリのドキュメントを確認するにはどうすればよいですか？

Yardサーバーを本番サーバーで実行するにはどうすればよいですか？多分いくつかのタスクを使用しますか？乗客とnginx、Jenkins（Hudson）を使用して、capistranoからロードします。

私は、管理している ruby​​gem を RDoc から YARD ドキュメントに切り替えようとしています。ただし、コード内にのみ残す必要があり、ドキュメントには表示されない重要なコメントがコード内にいくつかあります。例えば：

RDoc は#--and#++ゲートを尊重しますが、YARD は受け入れません。YARD のマークアップで類似のことを行うための構文は (存在する場合) は何ですか?

YARDを使用してRubyGemのドキュメントを作成しています。私のgemには、モジュールがクラスに含まれているこの一般的なルビーパターンに従うコードがあり、そのモジュールはインスタンスメソッドを追加するだけでなく、クラスメソッドも追加します。

デフォルトでは、YARDは次のようなFooクラスのドキュメントを生成します。

このドキュメントは、メソッドが利用可能であることをユーザーに通知していないため、不十分だと思います。Foo.helloについて学ぶhelloには、ユーザーはをクリックしてからをクリックする必要がありMooますClassMethods。

Foo1ページにすべてのクラスメソッドとインスタンスメソッドのリストがあると便利です。どうすればそれを実現できますか？コードを変更する必要がありますか、それともYARDにヒントを与えるために追加できるタグがありClassMethodsますか？

Yardで文書化したいRubyプログラミングチュートリアルを開発しています。デフォルトでは、Yardはモジュール/クラス内のすべてのメソッドをアルファベット順に配置します。ただし、チュートリアルの各モジュールのメソッドは相互に構築されているため、作成した順序で保持したいと思います。

メソッドをアルファベット順に並べないようにYardを構成する方法はありますか？

YARDを使用してテンプレートを文書化することは可能ですか、それともファイルにクラスが必要ですか？走ってみました

ヤードドキュメントコントローラー/モデル/ビュー/インデックス/

ただし、インデックスビューは取得されません。メタデータがドキュメントの追加ファイルに追加されるのがわかりますが、明らかにヤードコメントをレンダリングしたくありません。各ビューで使用されているパーシャルを文書化したいだけです。

どうも

Ruby on Rails 3.1.0 を使用しており、YARD 0.7.4 を使用しようとしています。定数値を文書化したいので、クラスで次のように述べます。

yardoc(またはyard doc) コマンドを実行した後の HTML 出力は次のとおりです。

上の画像では、HTML ドキュメントが適切にレンダリング/生成されていないことが示されています。少なくとも、私が期待するほどではありません。YAML のドキュメントを読みましたが、まだ問題があります。定数値に関連するドキュメントをより適切に記述および表示するにはどうすればよいですか?