問題タブ [rdoc]

私が走るとき

このエラーが発生します

これが--traceです

rake0.9.2とrdoc3.11をインストールしています。これらのコマンドをアプリのディレクトリで実行しています。

RDocマークアップを使用し、Yardでドキュメントを生成して、次のような行を持つコマンド出力を文書化しようとしています。

...しかし、これを達成する方法を理解することはできません。どうすればHTMLになりますか？

私はドキュメントで些細なことを見逃したと確信しています...

＃1を試す

マークアップをエスケープしようとせずに、この2つのスペースをインデントします（他のコード/プレブロックと同様）。

...ドキュメントを生成し、HTMLを取得します（予想どおり、私は推測します）：

＃2を試す

バックスラッシュを使用してエスケープする場合、このマークアップは次のとおりです。

...このHTMLになります：

＃3を試す

奇妙なことに、2つのプラス記号を連続して使用すると、このマークアップは次のようになります。

...このHTMLになります：

＃4をお試しください

インデントなしを使用<tt>すると、「逐語的」ではない（つまり、pre / code）セクションが残ります。単なるプレーンテキスト（ここでも、予想どおり、私は推測します）：

...このHTMLになります：

＃5をお試しください

インデントを使用する<tt>と、このマークアップが変わります。

...このHTMLに：

rdoc ドキュメントの最初のページに含めたい "ビジュアル" ツールでイメージを作成しました。フロントページは *.rdoc で定義されています。外部の画像を含めることは可能ですが、ローカルの画像を含めるにはどうすればよいですか?

更新: 回避策は、二重引用符なしで画像の html を追加することです:<img src=../../images/overview.jpg>画像がルート ディレクトリの画像フォルダーにある場合。(同じフォルダ内のいくつかのフォルダに rdoc を生成すると仮定します。) 適切な/>エンディングも機能しません。/が URL に追加されます。

RDoc 用の新しいジェネレーターを作成しようとしていますが、オブジェクトのdescription出力をカスタマイズする方法がわかりません。RDoc::ClassModule現在、次のようになっています。

「Gist」のリンクをカスタマイズして#!/search/Octopi::Gist、Gist.

どうすればこれを行うことができますか？

doc/README_FOR_APPの内容をに表示したいのdoc/app/index.htmlですがrake doc:app。

現在、内容は次のとおりです。

これは、RailsアプリケーションドキュメントのAPIドキュメントです。

を見るには、左側のページリストREADME_FOR_APPをクリックする必要があります。README_FOR_APP

RailsのREADME_FOR_APPの名前を変更または移動する方法を見てきましたが、OPは、彼が私が望む動作をすでに見ていると主張しています。

レール3.1.3を使用しています。

ただの警告: 私は Rails 初心者です。

私が実行すると：

この非推奨の警告が表示されます:

私は使用しています：

• レール 3.0.1
• レーキ 0.9.2.2
• RSpec 2.0.1
• RDoc 3.12

rake 0.9.2.2 をアンインストールして 0.8.7 を使用すると、警告は表示されませんが、それを解決策とは見なしません。

Google 検索の後、多くのサイトで Rakefile の行を更新する必要があると言われています (基本的には、require 'rake/rdoctask' を require 'rdoc/task' に変更します)。ただし、私の Rakefile は次のようになります。

置き換える必要のあるステートメントはありません。require 'rdoc/task' を追加しても効果がありません。非推奨の「rake/rdoctask」をプロジェクトで検索しても、結果がありません。では、なぜレールは不平を言っているのでしょうか?

編集:それが問題かどうかはわかりませんが、これが私のgemfileです:

Ubuntu 11.10 を使用しており、ruby 1.9.2 で rvm を使用しています。これを正確に実行してRubyをインストールしました：http://blog.sudobits.com/2011/10/27/how-to-install-ruby-on-rails-in-ubuntu-11-10/

でドキュメントを生成します

これは 1 回限りのターミナル セッションでは機能するようですが、終了して再度開始するとすぐに、ドキュメントを再度生成する必要があります。そうしないと、Nothing is Know エラーが発生します。端末セッションを開始するたびにドキュメントを生成します。

ドキュメントを永久に利用できるようにするためにできることはありますか?

確かにこれと同様の質問がありますが、ドキュメントを生成したり、インストールしたまま使用したりすることに問題はありません。

RDoc を実行しても、空白の一部のモジュールでは意味がありません。例えば：

RDoc は次のレポートを生成します。

レポート生成から空白の moduleName を削除するにはどうすればよいですか?

どんな助けでも大歓迎です、ありがとう。

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

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