2011-11-22 9 views
8

Me estoy metiendo en Ruby - una de las cosas que me está costando un poco dejar de lado es completar el código Intellisense, así que si no tengo eso realmente necesito tener la API a mano en todo momento. Hice el descubrimiento de la semana pasada:accediendo a la documentación de la biblioteca estándar de ruby ​​localmente

gem server 

que se inicia un servidor que le permite echa un vistazo a la documentación de todas las gemas instaladas. ¿Hay un equivalente a esto que te permita navegar por las bibliotecas estándar en lugar de las gemas?

Usando Linux/Ruby 1.8.7.

+1

¿Está desconectado codificación mucho? Porque si no, los documentos siempre están disponibles en http://rubydoc.info/stdlib. –

+3

Sí, código fuera de línea mucho mientras viajo, he estado usando rubydoc cuando estoy en casa, pero aún así sería bueno obtener los documentos en la línea de comando –

Respuesta

13

En su terminal, puede usar ri para imprimir partes específicas de la documentación. (Tenga en cuenta que si utiliza RVM para gestionar su instalación (s) de rubí, es posible que tenga que ejecutar rvm docs generate para evitar que "nada sabe acerca de ...." respuestas)

Por ejemplo:

> ri Array#drop 

sería de salida:

------------------------------------------------------------- Array#drop 
    ary.drop(n)    => array 
------------------------------------------------------------------------ 
    Drops first n elements from _ary_, and returns rest elements in an 
    array. 

     a = [1, 2, 3, 4, 5, 0] 
     a.drop(3)    # => [4, 5, 0] 
+0

Creo que aún me falta algo, amigo, esto es lo que obtengo de su cmd (aunque he notado que ri funciona para otras cosas) mikey @ mikey-netbook: ~ $ ri Array # drop Gemspec no válido en [/var/lib/gems/1.8/specifications/json_pure-1.6.1 .gemspec]: formato de fecha no válido en la especificación: "2011-09-18 00: 00: 00.000000000Z" Nada conocido sobre Array # drop –

+0

es genial, creo que drop podría ser un método 1.9.2, el comando ri funciona para otros métodos. ¡Aclamaciones! –

+0

No, 'drop' estaba en 1.8.x. Pero me alegra saber que está funcionando de otra manera. –

5

varias opciones:

+1

El primero (railsapi.com) está desactualizado, 'ri' es bastante básico (cuando está acostumbrado a la documentación a través de un IDE o a través de un navegador web: en primer lugar, debe saber la clase en la que desea los documentos y, en segundo lugar, no siempre funciona; por ejemplo, 'ri String' da No se conoce nada de String) y el último (doc) no funcionó. con Ruby 2.0.0. – Snowcrash

+0

@SnowCrash 1 eso es lo que dije, 2 es lo que es, son los documentos que están en el código, y si no se generan los documentos, no hay nada que mostrar, y 3 podrían ser, pero hace dos años Ruby 2 realmente no importaba –

2

Devdocs hace el trabajo

  • funciona sin conexión (también)
  • no se limita a la doc rubí;)

Clonar el repositorio de github:

git clone [email protected]:Thibaut/devdocs.git 
cd devdocs 

Install depende ncies:

gem install bundler 
bundle install 

descargar el docs:

thor docs:download --all 

Run que:

rackup 

Es accesible por defecto en http://localhost:9292

Cuestiones relacionadas