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?
views:
123answers:
2Thanks Greg:After posting the question, I have figured out that gem rdoc --all is the way to go for rdoc regeneration. For yardoc there seems to be no simple switch yet, like gem rdoc --yard or gem yardoc or something like that.
satynos
2010-07-02 17:16:09
If you have multiple gem installations or multiple Rubies installed, and are *not* using RVM, then I recommend looking into it. It can make your life easier. It might even have the capability to rebuild docs for all gemsets it manages. http://rvm.beginrescueend.com/
Greg
2010-07-03 01:10:42
+1
A:
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
Christoph Petschnig
2010-09-14 11:24:55
@Christoph: Is there any way to let yard store the gem object data somewhere else instead of the default .yardoc folder within the gem. The reason is that most of the IDEs while indexing the gems, are also indexing the data in .yardoc folder, which takes longer. I couldn't find a settings to exclude .yardoc pattern in any of the IDES. If I could have yard store this data somewhere like ~/.yardoc, would take care of the problem.
satynos
2010-09-15 17:05:55