And where can I find it? I'm running OSX.
In addition I have to do a lot of work offline while travelling so if anyone can offer any tips for downloadable documentation please let me know.
If you have installed your gems the "normal" way, they install rdoc documentation.
Just run gem server in your console and go to http://localhost:8808 in your browser. There you'll find all available Gems and the RDoc documentation
http://railsapi.com provides you to download offline documentation for:
Rails 2.2.2, 2.3.8, 3.0.8
Ruby 1.8, 1.9.2
Authlogic
AWS-S3
EventMachine
Haml
Hpricot
Nokogiri
Rack
Rspec
Sinatra
The downloadable file has wonderful jQuery search functionality, so it's pretty useful
#klaustopher's answer didn't work for me directly, so here is how I got this to work for the rspec-expectations gem:
Install gem documentation by either
using the --rdoc flag: gem install --rdoc rspec-expectations
or by installing rdocs for all gems: gem rdoc --all
Run rdoc server.
gem server
Go to http://localhost:8808 in my browser.
Caveat: at a first glance the rdoc for rspec-expectations is pretty useless. I bet there is a better way to do this.
Related
I recently installed the exception_notification plugin/gem (I'm confused as to whether it's properly install as a plugin or as a gem) and I'm getting this:
Could not find exception_notification-2.4.1 in any of the sources (Bundler::GemNotFound)
This is in spite of the fact that I already have that version of the gem installed:
$ gem list | grep exception_notification
exception_notification (2.5.2, 2.4.1)
Any ideas?
Maybe you're using a vendored bundle?
If so, it sounds like you just need to run
bundle install
In your rails directory. (Assuming you've already added that gem to your Gemspec).
http://gembundler.com/rails3.html
I am having trouble installing Ruby on Rails on OSX. I have gotten as far as too install the Rails, and have it create the application skeleton but when I go to run the server to test it's all working I get this:
Could not find gem 'sqlite3 (>= 0)' in any of the gem sources listed in your Gemfile.
sqlite is in the gem folder/list:
* LOCAL GEMS *
sqlite3-ruby (1.2.4)
Any idea?
Found out solution was here:
http://www.ruby-forum.com/topic/1074909
When I gem server and go to the page, I notice there wasn't a link to the RDoc, and when I move to there a pop out says RDoc is not installed.
But when I type rdoc --help in terminal, there is a reply. How to get to the rdoc, because I need to read omniauth rdoc?
I just tried using Rails 3.0.1 and Ruby 1.9.2 on a Mac and it worked... no rdocs content for omniauth itself but there are docs for oa-basic, oa-core, oa-enterprise, oa-oauth, oa-openid
You can consider uninstalling omni-auth and reinstalling it
gem uninstall omniauth
gem install omniauth
and see if the rdoc get built. Also, if you use RVM on Mac or Linux, you can create a new gemset and then install omniauth again and try.
Solve it by using sudo gem rdoc omniauth ... but nothing inside
I use gem install rails -v=2.3.8 to install rails, and it says rdoc and ri has been generated.
But when I gem server, I can't open the rails doc in browser, it says doc_root/rails-2.3.8/rdoc/index.html not found
I looked into /usr/local/lib/ruby/gems/1.8/doc/rails-2.3.8/rdoc, found it is empty.
How to fix it? How to generate the rdoc by gem?
Maybe re-generating might help: sudo gem rdoc --all
Can you try this DIR "/usr/lib/ruby/gems/1.8/doc/rails-2.3.5/"
I would like to read Rails documentation locally though gem server.
I go to http://localhost:8808/ and Rails 2.3.3 gem is in the list of the gems installed, but when I click [rdoc] I get:
`/doc_root/rails-2.3.3/rdoc/index.html' not found.
I tried to uninstall and reinstall Rails but I got no effect.
All other gems work properly, why I can't see Rails documentation?
Rails itself has no documentation while you can read rdocs about actionmailer, actionpack, activerecord, activeresource or activesupport.
You can try to explicitly generate ri and rdoc during gem installation. The command is as follows:
$ sudo gem install rails --rdoc --ri
Cheers
http://railsapi.com/
Just download this to your gem docs dir.