¿Cómo activo “Haga clic para activar la fuente” botón en Ruby RDoc?

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

  •  25-09-2019
  •  | 
  •  

Pregunta

Cuando se utiliza el generador de RDoc Darkfish para generar la documentación RDoc, junto a métodos hay un botón Click to toggle source junto a cada método. No está funcionando para mí cuando genero mi documentación, por lo que ¿cómo se consigue que la característica funcione, tienes que añadir una palabra clave en su fuente RDoc o algo? text alt

¿Fue útil?

Solución

Yo tenía los mismos problemas y encontrar los archivos que faltan en http://rack.rubyforge.org/doc / js . Yo les copiado manualmente en un doc / app / js dir y ahora Haga clic para alternar la fuente obras. Esto es, al menos, una solución rápida.

Otros consejos

Parece ser activado por defecto. Acabo de intentar una prueba rápida con v2.5.11 rdoc: - 

$ 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

Cuando hago clic en el enlace para #my_method y yo Pase el ratón sobre la descripción del método, veo el "Haga clic para activar la fuente" enlace y funciona cuando hago clic en él.

Se necesitará tener activado Javascript en su navegador para hacer este trabajo.

Estoy teniendo el mismo problema con mi código Rails3. Su bastante genérico y no recuerdo haber jugado con la configuración RDoc, pero mi click to toggle source no funciona bien. Sé que JS está encendida y su no ha habido errores cuando corro rake doc:app así que estoy muy seguro de qué se está encendiendo.

Lo único que se me ocurre es que estoy corriendo de Ruby 1.9.2 / 3.0.0 Carriles bajo RVM. ¿Tiene que hacer una diferencia?

ACTUALIZACIÓN: Me di cuenta de que su tratando de cargar archivos Javascript inexistentes desde un directorio js. Se supone RDoc para insertar los archivos JS o se supone que debes hacerlo de forma manual?

Esto es un problema en una vieja versiones de rdoc que están trabajando junto con RVM. Yo tenía el mismo problema con la versión 2.5.8. La ruta de acceso al directorio de plantillas contiene .rvm, por lo que las imágenes y JS directorios no se copian en la documentación generada. Como solución, puede cambiar esta línea de código en lib / rdoc / darkfish.rb archivo generador / 

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

a 

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

Gracias a Jeremy Bopp (para descubrir el origen de este problema - http://rubyforge.org/tracker/index.php?func=detail&aid=28482&group_id=627&atid=2472 ) y Gordon Thiesfeld (para dar solución - http://rubyforge.org/tracker/?func=detail&atid=2472&aid=26923&group_id=627 ) de Rubyforge.com

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top