問題タブ [rdoc]

ruby コードファイルをそのまま RDoc にインクルードするにはどうすればよいですか?

gem の使用方法を文書化した example.rb ファイルがあり、それを README.rdoc や HISTORY.rdoc などのファイルの 1 つとして含めたいと考えています。

Syntax gemを使用して ruby​​ ソース コードを HTML に変換する方法は既に理解しましたが、解析せずに RDoc にファイルを含める方法がわかりません。

RDoc に html ファイルを含めるように指示すると、それはリストされず、ファイル拡張子として rdoc または txt を使用してそれを偽造すると、適切に表示されません (ファイルは実際にはまだ html です)。

私はうまくいく解決策を持っていますが、それは信じられないほど醜いです。これを行うには、rdoc 固有のより良い方法が必要ですが、私にはわかりません。

これが私のRakefileにあるものです：

クラスで RDoc コメントを使用して記述したいくつかの rake タスクを文書化しようとしていますが、角かっこを表す際に問題が発生しています。パラメータを指定して rake タスクを実行する方法の例をいくつか追加したいので、次のような rdoc 行を作成します。

＃例。rake build[MyProject]

問題は、RDoc パーサー convert が角かっこを出力する代わりにリンクを作成することです。私はあらゆる種類のエスケープ シーケンスを試しました。[[; ＃{[私のプロジェクト]} ; [マイプロジェクト] しかし、何も機能していないようです。

リンクに変換されないように、これらの角括弧をエスケープする方法はありますか?

ありがとう、アーロン

スクリプトの先頭にあるコメントではなく、使用方法のドキュメントを readme ファイル (duh) に保存したいと思います。RDoc::usage を取得して、スクリプト コメントの代わりに readme から使用情報を取得するにはどうすればよいですか?

When I gem server and go to the page, I notice there wasn't a link to the RDoc, and when I move to there a pop out says RDoc is not installed.

But when I type rdoc --help in terminal, there is a reply. How to get to the rdoc, because I need to read omniauth rdoc?

ri バージョン 2.5.8 と ruby​​ 1.9.2 を実行しています。のようなものを試してみるとri Enumerable | less、ページングが壊れにくくなります。出力は表示されますが、CTRL-F または CTRL-B を使用してページを前後に移動できません。試してみると、画面の下部にリテラルの "^F" と "^B" の文字が出力されるだけです。どうしたの？

riコマンドプロンプトで入力すると、何も返されません：

ri が知っているクラスとモジュール:

これを正しく設定するにはどうすればよいですか？どうもありがとう。

RDoc には :include: タグ (このページの下部を参照) があり、任意のテキスト ファイルを取り込んで、インクルードが始まる場所でインデントされているかのようにフォーマットします。これは、ドキュメントの例のソース コードを取り込むのに最適な方法です。

Yardにも同様のタグや機能がありますか?

次のクラスがあるとします。

そして、それを rdoc で実行します。

$ rdoc foo.rb

それはこれを生成します：

代わりに次のようなものを生成したい：

これを達成するための最良の方法は何ですか？

私が作成しているgemには、いかなる種類のインラインri/rdocもありません。そのため、ユーザーがgem installそれを使用すると、rubygemsがドキュメントをコンパイルしようとすると警告が表示されます:

これは、存在しないアプリの lib フォルダーに対して ri ツールを実行しようとしたことが原因であると想定しています (gem はすべてバイナリです)。このエラーを回避するにはどうすればよいですか? ダミーファイルを配置しようとしましlib/たが、役に立ちませんでした。

バンドラー駆動のプロジェクトで fastri エンジンを動作させたいと考えています。誰でもこれを行う方法を知っています。