How to view core ruby documentation locally?

Question

I have installed Ruby 2.0.0 with rvm and want to have local html documentation. So I run

$ rvm docs generate
Installing rdoc-data................................................................
Generating gems documentation.......
$ rvm docs open
rdoc docs are missing, perhaps run 'rvm docs generate' first?

What is wrong?

score 2 · Accepted Answer · answered Sep 08 '14 at 18:01

Here's what works for me for RVM:

rdoc $MY_RUBY_HOME -o ~/ruby_docs

That puts the HTML documentation for the core and standard libraries in your $HOME/ruby_docs directory. Then, if you're on Mac OS, simply run:

open ~/ruby_docs/index.html

or navigate to the directory and open index.html somehow for other OSes.

score 1 · Answer 2 · answered Sep 08 '14 at 12:59

1

I recommend using this app https://itunes.apple.com/gb/app/dash-docs-snippets/id458034879?mt=12 Allows you to access documentation for any language.

answered Sep 08 '14 at 12:59

DMH

2,529
3
24
35

Thank you for the link, I'll give this app a try. But its nice just to have rdoc html on my laptop. – lexsys Sep 08 '14 at 13:26
@Lexsys this will still give you access to the docs locally. its just another means to an end. – DMH Sep 08 '14 at 21:01

score 0 · Answer 3 · answered Sep 08 '14 at 13:44

0

Try gem update rdoc and then generate the docs. I had the same issue and this solved it.

answered Sep 08 '14 at 13:44

kriskova

568
3
7

Do you have a '.rvm/docs/ruby-2.0.0/rdoc folder in your home directory? What operating system do you use? – kriskova Sep 08 '14 at 14:03
There is no such folder: `$ ls ~/.rvm/docs/ alt.md color.md upgrade-notes.md ` – lexsys Sep 08 '14 at 16:53
I am on mac os x 10.9 – lexsys Sep 08 '14 at 16:54
`gem update rdoc` would update the rdoc gem, but won't do anything for the core library documentation. – the Tin Man Sep 08 '14 at 17:37

How to view core ruby documentation locally?

3 Answers3