Generating stdlib documentation

ruby-talk
1

Hi,
  I just tried 'rdoc ~/ruby/lib -f html -o /tmp/ruby_1.9_stdlib' in an attempt to generate the stdlib docs for ruby 1.9 (~/ruby is 1.9 from cvs), but it doesn't appear to have gotten everything (e.g. GServer documentation is missing although it exists in ~/ruby/lib/gserver.rb). What is the generally accepted method for generating the stdlib docs?

Thanks,
Ryan

2

lists wrote:

Hi,
  I just tried 'rdoc ~/ruby/lib -f html -o /tmp/ruby_1.9_stdlib' in an
attempt to generate the stdlib docs for ruby 1.9 (~/ruby is 1.9 from
cvs), but it doesn't appear to have gotten everything (e.g. GServer
documentation is missing although it exists in ~/ruby/lib/
gserver.rb). What is the generally accepted method for generating
the stdlib docs?

Check for .document files: there'll almost certainly be one in
ruby/lib. They list files in be included in an RDoc job. Delete those
files if you want everything.

Gavin

3

Wahoo, thanks!

-Ryan

···

On Nov 7, 2005, at 11:42 PM, Gavin Sinclair wrote:

lists wrote:

Hi,
  I just tried 'rdoc ~/ruby/lib -f html -o /tmp/ruby_1.9_stdlib' in an
attempt to generate the stdlib docs for ruby 1.9 (~/ruby is 1.9 from
cvs), but it doesn't appear to have gotten everything (e.g. GServer
documentation is missing although it exists in ~/ruby/lib/
gserver.rb). What is the generally accepted method for generating
the stdlib docs?

Check for .document files: there'll almost certainly be one in
ruby/lib. They list files in be included in an RDoc job. Delete those
files if you want everything.

Gavin