Как включить кнопку «Нажмите на кнопку Toggle Source» в RUBY RDOC?

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

  •  25-09-2019
  •  | 
  •  

Вопрос

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

Это было полезно?

Решение

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

Другие советы

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

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

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

ОБНОВИТЬ: Я заметил, что он пытается загрузить несуществующие файлы JavaScript из js каталог. Должен ли RDOC, чтобы вставить файлы JS или вы должны делать это вручную?

Это проблема в старых версиях RDOC, которые работают вместе с RVM. У меня была такая же проблема с версией 2.5.8. Путь к каталогу шаблонов содержит .rvm, поэтому изображения и каталоги 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 ust=26923&group_id=627.) от RubyForge.com.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top