accesso alla documentazione della libreria standard ruby ​​localmente

Question

Sto entrando in Ruby - una delle cose che ho un po 'di problemi a lasciare è Intellisense/completamento del codice, quindi se non ce l'ho ho davvero bisogno di avere l'API a portata di mano in ogni momento. Ho fatto la scoperta ultima settimana di:

gem server 

che avvia un server che consente di controllare la documentazione per tutte le gemme installati. C'è un equivalente a questo che ti permette di sfogliare le librerie standard invece delle gemme?

Uso di Linux/Ruby 1.8.7.

Answer 1

Nel terminale, è possibile utilizzare ri per stampare parti specifiche della documentazione. (Si noti che se si sta utilizzando RVM per gestire l'installazione di rubino (s), potrebbe essere necessario eseguire rvm docs generate per evitare di essere "Niente saputo ...." risposte)

Ad esempio:

> ri Array#drop 

sarebbe uscita:

------------------------------------------------------------- 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] 

Answer 2

diverse opzioni:

• Local, searchable Rails and Ruby docs (opzioni per aggiungere ot i suoi documenti come Haml, RSpec, rack, ecc, ma non del tutto up-to-date)
• Create from source
• ri
• ... and a million tools to generate snazzy docs from Ruby source, tra cui ...
• doc, che genera documenti ricercabili locali di qualsiasi lo dici a; Sto scavando che

Answer 3

Devdocs fa il lavoro

• funziona (anche) offline
• non si limita al doc rubino;)

Clone repo da github:

git clone git@github.com:Thibaut/devdocs.git 
cd devdocs 

Installare depende ncies:

gem install bundler 
bundle install 

scaricare la documentazione:

thor docs:download --all 

eseguirlo:

rackup 

E 'accessibile in modo predefinito a http://localhost:9292