Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to rebuild rdoc for all the installed gems?

Tags:

ruby

rdoc

yard

I have several gems installed in multiple locations.

What is the hard/easy way to generate/re-generate:

  • rdoc for all these installed gems, all at once?
  • yardoc for all these installed gems, all at once?
like image 720
Dharam Gollapudi Avatar asked Jun 30 '10 19:06

Dharam Gollapudi


People also ask

Which is the command used to list all the gems available in Ruby?

The list command is used to view the gems you have installed locally.

How gem libraries are installed and used?

The main place where libraries are hosted is RubyGems.org, a public repository of gems that can be searched and installed onto your machine. You may browse and search for gems using the RubyGems website, or use the gem command. Using gem search -r , you can search RubyGems' repository.

Where do RubyGems get installed?

When you use the --user-install option, RubyGems will install the gems to a directory inside your home directory, something like ~/. gem/ruby/1.9. 1 . The commands provided by the gems you installed will end up in ~/.

How do I check RubyGems version?

You can check your Ruby version by running ruby --version , and you can check your RubyGems version by running gem --version . If you need to upgrade Ruby, use your ruby version manager's instructions. If you need to upgrade RubyGems, run gem update --system .


2 Answers

Have you tried one of these?

gem rdoc --all
gem rdoc --all --overwrite
like image 180
the Tin Man Avatar answered Oct 21 '22 21:10

the Tin Man


yard gems

or

sudo yard gems

should do the job. You may also want to use the --rebuild flag. If you want to run a local Yardoc server for your installed gems, then run

yard server -g
like image 34
Christoph Petschnig Avatar answered Oct 21 '22 20:10

Christoph Petschnig