# Getting ri to include rdoc for my rails gems

**URL:** <https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947>\
**Category:** Rails\
**Created:** [December 23, 2005, 2:14am UTC](https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947 "2005-12-23T02:14:09Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![todd](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/fbc32d/32.png) [@todd](https://www.ruby-forum.com/u/todd)\
**Post date:** [December 23, 2005, 2:14am UTC](https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947/1 "2005-12-23T02:14:09Z")

</div>

I’ve installed Ruby 1.8.2 and Rails 1.0 on Windows XP and it’s working  
great. However, ri, doesn’t seem to know about any of the rdocs for the  
rails classes. For example if I run “ri --classes” none of the  
ActiveRecord classes are listed. What’s the correct way to get ri to  
include rails classes?

Thanks,  
Todd

---

<div class="post-metadata">

**Author:** ![todd](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/fbc32d/32.png) [@todd](https://www.ruby-forum.com/u/todd)\
**Post date:** [December 23, 2005, 7:56am UTC](https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947/2 "2005-12-23T07:56:15Z")

</div>

The best way I have found to do this shoud be to use rimport  
([http://rimport.rubyforge.org/](http://rimport.rubyforge.org/)) . please fully read and understand the  
caveats section before you use it. I couldn’t get it to work perfectly  
for me.

However you also have the option of using the gems documentation  
server to access rails rdoc while offline. For this you basically want  
to run ‘gem\_server’ (see man for more options)

jean

---

<div class="post-metadata">

**Author:** ![todd](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/fbc32d/32.png) [@todd](https://www.ruby-forum.com/u/todd)\
**Post date:** [December 23, 2005, 6:47pm UTC](https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947/3 "2005-12-23T18:47:33Z")

</div>

On 12/23/05, Todd [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> Thanks for the pointer to rimport, any idea if anyone is working  
> on better ri-gems integration out of the box without a 3rd  
> party tool?

Sorry, I have no idea.  
When I came acrosse the problem, I went as far as rimport, and when I  
saw how fragile RI file structure was, I dropped it altogether, bought  
the pickaxe, and went on with gem\_server.

Jean

---

<div class="post-metadata">

**Author:** ![todd](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/fbc32d/32.png) [@todd](https://www.ruby-forum.com/u/todd)\
**Post date:** [December 23, 2005, 1:19pm UTC](https://www.ruby-forum.com/t/getting-ri-to-include-rdoc-for-my-rails-gems/50947/4 "2005-12-23T13:19:33Z")

</div>

I’ve used the gem\_server option which does the trick but I find the ri  
command line approach much quicker if I know what I’m looking for.

As a new user it’s quite confusing for me that ri only includes the core  
API and not the rdoc for installed gems as well. I just assumed for a  
long time that I had something wrong with my installation. Thanks for  
the pointer to rimport, any idea if anyone is working on better ri-gems  
integration out of the box without a 3rd party tool?

Thanks,  
Todd