Как включить кнопку «Нажмите, чтобы переключить источник» в Ruby RDoc?

Question

При использовании генератора Darkfish RDoc для генерации документации RDoc рядом с методами рядом с каждым методом имеется кнопка Click to toggle source.Это не работает для меня, когда я создаю свою документацию, так как вы заставляете эту функцию работать, вам нужно добавить ключевое слово в ваш источник RDoc или что-то еще?

Answer 1

У меня были те же проблемы, и я обнаружил отсутствующие файлы в http://rack.rubyforge.org/doc/js.Я скопировал их вручную в doc / app / js dir и теперь Нажмите, чтобы переключить источник работает.Это как минимум быстрое решение.

Answer 2

У меня такая же проблема с моим кодом Rails3. Он довольно общий, и я не помню, чтобы он играл с настройкой RDoc, но мой click to toggle source тоже не работает. Я знаю, что JS включен, и у меня не было никаких ошибок, когда я запускаю rake doc:app, поэтому я не совсем уверен, что происходит.

Единственное, о чем я могу думать, это то, что я использую Ruby 1.9.2 / Rails 3.0.0 под RVM. Это имеет значение?

ОБНОВЛЕНИЕ: Я заметил, что он пытается загрузить несуществующие файлы Javascript из каталога js. RDoc должен вставлять файлы JS или вы должны делать это вручную?

Answer 3

Кажется, он включен по умолчанию. Я только что попробовал быстрый тест с 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 и нахожу указатель мыши на описании метода, я вижу ссылку «Нажмите, чтобы переключить источник», и она работает, когда я щелкаю по ней.

Вам потребуется включить JavaScript в вашем браузере, чтобы эта работа работала.

Answer 4

Это проблема в старых версиях rdoc, которые работают вместе с rvm.У меня была такая же проблема с версией 2.5.8.Путь к каталогу шаблонов содержит .rvm, поэтому каталоги images и js не копируются в сгенерированную документацию.Как исправить, вы можете изменить эту строку кода в файле lib / rdoc / generator / darkfish.rb

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

на

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

Спасибо Джереми Боппу (за обнаруженный источникэтот вопрос - 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