ярд, как включить изображение в документацию?

Question

Я хочу включить изображение во внутреннюю документацию, но нигде не могу найти, как это сделать ... Кто-нибудь знает, как это сделать?

Answer 1

Вы можете просто добавить тег <img /> к своей документации:

 # Blah-blah 
 # 
 # <img src=img/1.png />
 # @param [String] blah
 # @return [String] blah
 def foo(bar) 

 end

Answer 2

Использование rdoc-image: ссылки:

# Gets foo.
#
# rdoc-image:img/1.png
def foo(bar)
  "foo"
end

отображается YARD в

<p>Gets foo.</p>
<p><img src="img/1.png"></p>

rdoc-images: также работает в отдельных *.rdoc файлах.

Answer 3

В зависимости от формата разметки вам может понадобиться другой механизм.Например, если вы используете Markdown, синтаксис будет ![Alt text](/path/to/img.jpg).В RDoc тег img должен работать, но вы можете проверить, добавил ли он специальный синтаксис разметки для этого.Обратите внимание, что RDoc, вероятно (не уверен), не любит XHTML, вы должны использовать без окончания /.