Generar documentación en Ruby al estilo RoR
Para generar la documentación de un proyecto Ruby se utiliza el comando rdoc, este comando tiene un template por defecto, pero lo podemos cambiar añadiendo templates en el subdirectorio #{RUBY_SOURCE}/lib/ruby/1.8/rdoc/generators/template/htmlEl template de rdoc utilizado en la api de Ruby on Rails se llama jamis.rb. Para generar la documentación con este template tenemos que seguir los siguientes pasos:
- Descargar el template jamis.rb ( http://www.jamisbuck.org/svn/rdoc-templates/jamis.rb ) y guardarlo en el subdirectorio de templates ( #{RUBY_SOURCE}/lib/ruby/1.8/rdoc/generators/template/html )
- Ir a la raíz de nuestro proyecto ruby.
- Ejecutar:
rdoc [SUBDIRECTORIOS | FICHEROS] --template=jamis \
--line-numbers --inline-source
Etiquetas: rails, ruby, RubyOnRails
0 Comentarios (Publicar un comentario)