patio, ¿Cómo incluir la imagen en la documentación?

Question

Quiero incluir la imagen en la documentación generada en el patio, pero no puedo encontrar en ninguna parte cómo hacerlo ... ¿Alguien sabe cómo hacer esto?

Answer 1

Usted puede añadir <img /> etiqueta a su documentación:

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

end 

Answer 2

Dependiendo de su formato de marcado puede que tenga que utilizar otro mecanismo. Por ejemplo, si usa Markdown, la sintaxis es ![Alt text](/path/to/img.jpg). En RDoc, una etiqueta img debería funcionar, pero puede verificar si han agregado una sintaxis de marcado especial para esto. Tenga en cuenta que RDoc probablemente (no estoy seguro) no le gusta XHTML, debe usar sin final /.

Answer 3

Uso rdoc-image: enlaces:

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

dicte su jardín en

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

El rdoc-images: también trabaja en autónomos *.rdoc archivos.