Daily Archive for Lunes, junio 22nd, 2009

Es difícil quitarse el hábito de consultar la documentación en línea, por lo regular ando siempre conectado a internet y se me hace muy fácil escribir en Google algo como rails doc o ruby doc, dar clic y comenzar a buscar lo que necesito en la documentación.

Recientemente me vi en la necesidad de poder acceder de manera local a la documentación de Rails y de Ruby — además de que la velocidad no se compara.

La documentación de Rails

Para generar la documentación de Rails tecleamos lo siguiente:

1
2
3
4
5

rails temp_app
cd temp_app
rake rails:freeze:gems
rake doc:rails
rake rails:unfreeze

Lo que hacemos es generar una aplicación temporal, después congelamos las gemas de Rails en la aplicación de ejemplo, y a continuación generamos la documentación.
El último paso se usa para descongelar las gemas en nuestra aplicación de ejemplo (aunque también podemos sólo borrar el directorio de la aplicación después de mover la documentación de ahí).

Si tienes Apache instalado en tu Ubuntu, entonces mueve la documentación a tu directorio web y elimina la aplicación de ejemplo con:

1
2
3
4

sudo mkdir /var/www/docs
sudo mv doc/api /var/www/docs/rails
cd ..
rm -rf temp_app

Ahora puedes accesarla desde:
http://localhost/docs/rails

La documentación de Ruby

Para generar la documentación de Ruby teclea lo siguiente:

1
2

cd /usr/lib/ruby/1.8
sudo rdoc -o /var/www/docs/ruby

Ahora puedes accesarla desde:
http://localhost/docs/ruby

Depredado en

Rails Documentation

Artículos relacionados:

• Cómo mostrar las sentencias SQL en la consola de Rails
• Programando un PBBG en Ruby & Rails
• Cómo instalar PostgreSQL en Ubuntu 9.04 y 9.10
• Railscasts — Videotutoriales de Rails
• Un par de revistas gratuitas para los rubyistas y raileros