[Nitro] Rdocs

Emmanuel Piperakis epiperak at softlab.ece.ntua.gr
Wed Sep 7 01:26:03 EDT 2005


Thanx! :-|

> Emmanuel Piperakis wrote:
>>> I *think* you can run rdoc over the source tree, and then copy the
>>> resulting docs over to where they should be in the gems/docs tree
>>
>>
>> I tried rake rdoc, rake doc (no result). Probably my rake is not
>> installed correctly......
>>
>
> Forget rake.  Just run rdoc.
>
>
> C:\ruby\lib\ruby\gems\1.8\gems\og-0.23.0\lib>rdoc --main og.rb
>
>                      collection.rb: mc................
>                          entity.rb: mm.m....................cc.
>                          errors.rb: mc.
> # much stuff ...
>                        mysql411.rb: c.............
> Generating HTML...
>
> Files:   37
> Classes: 52
> Modules: 51
> Methods: 520
> Elapsed: 16.563s
>
> C:\ruby\lib\ruby\gems\1.8\gems\og-0.23.0\lib>
>
> This produces a 'doc' directory, with the rdoc files.  Copy the contents of 
> that 'doc' dir to
>
> C:\ruby\lib\ruby\gems\1.8\doc\og-0.23.0\rdoc
>
> Adjust where needed on *nix boxen.
>
> Actually, the README file in the main Og source directory makes a better main 
> page for the rdoc, so you may consider moving it to the lib ir before running 
> rdoc, and setting that as the main page:
>
> rdoc --main README
>
>
> But this should give you an idea of what to do.
>
> James
>
> -- 
>
> http://www.ruby-doc.org - The Ruby Documentation Site
> http://www.rubyxml.com  - News, Articles, and Listings for Ruby & XML
> http://www.rubystuff.com - The Ruby Store for Ruby Stuff
> http://www.jamesbritt.com  - Playing with Better Toys
> _______________________________________________
> Nitro-general mailing list
> Nitro-general at rubyforge.org
> http://rubyforge.org/mailman/listinfo/nitro-general
>

Emmanouil Piperakis (epiperak at cs.ntua.gr)
{To explore is Human, to Create is Devine,
  To teach is Primal, to Rule is Sin}



More information about the Nitro-general mailing list