truy cập tài liệu thư viện chuẩn ruby ​​cục bộ

Question

Tôi vừa mới tham gia Ruby - một trong những điều tôi gặp phải một chút rắc rối khi hoàn thành Intellisense/code, vì vậy nếu tôi không có thì tôi thực sự cần phải có API luôn ở gần mọi lúc. Tôi đã thực hiện khám phá vào tuần trước là:

gem server 

khởi động máy chủ cho phép bạn xem tài liệu về tất cả các đá quý đã cài đặt của mình. Có tương đương với điều này cho phép bạn duyệt các thư viện chuẩn thay vì đá quý không?

Sử dụng Linux/Ruby 1.8.7.

Answer 1

Trong thiết bị đầu cuối của bạn, bạn có thể sử dụng ri để in các phần cụ thể của tài liệu. (Lưu ý rằng nếu bạn đang sử dụng RVM để quản lý cài đặt ruby ​​của bạn (s), bạn có thể cần phải chạy rvm docs generate để tránh bị "Không có gì được biết về ...." phản ứng)

Ví dụ:

> ri Array#drop 

sẽ đầu ra:

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

Một số tùy chọn:

• Local, searchable Rails and Ruby docs (tùy chọn để thêm ot docs cô như Haml, rspec, rack, vv, nhưng không hoàn toàn up-to-date)
• Create from source
• ri
• ... and a million tools to generate snazzy docs from Ruby source, bao gồm ...
• doc, mà tạo ra tài liệu có thể tìm kiếm địa phương của bất cứ điều gì bạn nói với nó; Tôi đang đào nó

Answer 3

Devdocs hiện công việc

• nó hoạt động (cũng) ẩn
• nó không được giới hạn ở những doc ruby;)

Clone repo từ github:

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

Cài đặt depende ncies:

gem install bundler 
bundle install 

tải các tài liệu:

thor docs:download --all 

Run nó:

rackup 

Nó có thể truy cập bằng cách mặc định tại http://localhost:9292