Ruby RDoc で「クリックしてソースを切り替え」ボタンを有効にするにはどうすればよいですか?

StackOverflow https://stackoverflow.com/questions/3800704

  •  25-09-2019
  •  | 
  •  

質問

Darkfish RDoc ジェネレーターを使用して RDoc ドキュメントを生成する場合、メソッドの隣に Click to toggle source 各メソッドの横にあるボタンをクリックします。ドキュメントを生成するときに機能しません。どうすればその機能を機能させることができますか。RDoc ソースなどにキーワードを追加する必要がありますか?alt text

役に立ちましたか？

解決

私は http://rack.rubyforge.org/docで同じ問題を抱えていたし、足りないファイルを見つけました/ JS に。 私はアプリ/ jsのディレクトリ/ docに手動でコピーして、今、のトグルソースの作品をクリックしてください。 これは、少なくとも簡単な修正である。

他のヒント

デフォルトで有効になっているようです。私はちょうどRDOCのv2.5.11で簡単なテストを試してみました： - 

$ mkdir temp
$ cd temp
$ cat temp.rb

class MyClass
  def my_method; end
end

$ rdoc
Parsing sources...
100% [ 1/ 1]  temp.rb                                                           

Generating Darkfish...

Files:         1
Classes:       1 (    1 undocumented)
Constants:     0 (    0 undocumented)
Modules:       0 (    0 undocumented)
Methods:       1 (    1 undocumented)
  0.00% documented

Elapsed: 0.1s
$ open doc/index.html

私は方法の説明以上#my_methodとIホバーのためのリンクをクリックすると、私は「クリックトグルソースへ」のリンクを参照してください、私はそれをクリックしたとき、それは動作します。

あなたはJavaScriptを有効にして仕事をするために、ブラウザで有効になって必要になります。

私と同じような問題もRails3ます。写ジェネリック薬や記憶してないのRDocの設定が、私の click to toggle source 動作しない。知っていることJSをonとなっていないエラー時に実行し rake doc:app いていませんでなかなかいいただきました。

しかし、面白いことを考えることができるのは私の走行Ruby1.9.2/レール3.0.0下RVM.なること間関係についての理解を得ます。

更新: 気がつくとそのように負荷が存在しないJavascriptファイルから js ディレクトリです。はRDocれを挿入するJSファイルで指定されている処理を実行しますので手動で?

これは、rvm と連携して動作する古いバージョンの rdoc の問題です。2.5.8バージョンでも同じ問題が発生しました。テンプレート ディレクトリへのパスには .rvm が含まれるため、画像と js ディレクトリは生成されたドキュメントにコピーされません。修正として、lib/rdoc/generator/darkfish.rb ファイルのこのコード行を変更できます。

next if path =~ /#{File::SEPARATOR}\./

に

next if path =~ /#{@template_dir}.*#{File::SEPARATOR}\./

Jeremy Bopp に感謝します (この問題の原因を発見してくれました - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472）とゴードン・ティースフェルド（解決策を与えるために - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627）Rubyforge.comより

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top