Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

All Ruby documentation offline with yard

Tags:

ruby

yard

If I want see documentation on my gems I can do:

yard server --gems

How can I see the documentation of Ruby's standard library?

like image 648
Rusty Robot Avatar asked Dec 01 '11 19:12

Rusty Robot


1 Answers

You have to

  1. download the Ruby code archive and extract it into a directory,
  2. run yardoc *.c (that will generate the core documentation), 2a. run yardoc . (that will generate the stdlib documentation but will take a lot of time),
  3. run yard server.

(from http://gnuu.org/2010/10/13/local-copies-of-documentation/)

like image 183
gioele Avatar answered Sep 22 '22 18:09

gioele