Merb devel - May 2009 - generating rdoc documentation with merb_generator?

Dear all,

Our company spent a year programming with hardly any documentation.
I''ve
spent the last two weeks adding this in rdoc format to the controller
and various library files. So now I need to generate the actual
documentation. I ran into some trouble:-

Our app has two branches historically. The older one has apps for which
merb-gen generated an empty ''doc'' directory (well, I
don''t know if it
was completely empty, but it gave me no issues). So I could run rdoc in
the branch root and this generated documentation smoothly in
''doc/rdoc''
no problem. GOOD!

The newer branch has apps for which merb-gen generated a doc directory
containing ''rdoc'' and ''rdoc/generators''
where there is a
''merb_generator.rb'' file. Now when I try to run rdoc from the
branch
root I get an error message telling me to specify the rdoc target
directory to avoid overwriting existing documentation (currently there
isn''t any, see below). OOPS!

So I wonder how can doc/rdoc/generators/merb_generator.rb be used to do
the job instead (which I assume is why it is generated by merb-gen)...

Reading the source code was interesting but unhelpful for my level of
understanding of merb''s structure. I tried to run it with merb -r
without any effect. Also I could not find a single tutorial or
documentation online in the merb site, merbist, or dozens of
merb-related blogs. Hmmm, I think I am missing something so basic
everyone knows it!

Any help appreciated. Many thanks in advance,
Gernot
-- 
Gernot Hassenpflug

I didn''t check on the rdoc generator, but I think it was contributed by
Rob
Kaufman if I remember correctly. Nothing will break if you remove the rdoc
directory, so feel free to remove it if it gives you problems.

you might want to join the google groups mailing list:
http://groups.google.com/group/merb since very few people check on the RF
mailing list.

- Matt

On Thu, May 7, 2009 at 7:48 PM, Gernot Hassenpflug <aikishugyo at
gmail.com>wrote:
> Dear all,
>
> Our company spent a year programming with hardly any documentation.
I''ve
> spent the last two weeks adding this in rdoc format to the controller
> and various library files. So now I need to generate the actual
> documentation. I ran into some trouble:-
>
> Our app has two branches historically. The older one has apps for which
> merb-gen generated an empty ''doc'' directory (well, I
don''t know if it
> was completely empty, but it gave me no issues). So I could run rdoc in
> the branch root and this generated documentation smoothly in
''doc/rdoc''
> no problem. GOOD!
>
> The newer branch has apps for which merb-gen generated a doc directory
> containing ''rdoc'' and ''rdoc/generators''
where there is a
> ''merb_generator.rb'' file. Now when I try to run rdoc from
the branch
> root I get an error message telling me to specify the rdoc target
> directory to avoid overwriting existing documentation (currently there
> isn''t any, see below). OOPS!
>
> So I wonder how can doc/rdoc/generators/merb_generator.rb be used to do
> the job instead (which I assume is why it is generated by merb-gen)...
>
> Reading the source code was interesting but unhelpful for my level of
> understanding of merb''s structure. I tried to run it with merb -r
> without any effect. Also I could not find a single tutorial or
> documentation online in the merb site, merbist, or dozens of
> merb-related blogs. Hmmm, I think I am missing something so basic
> everyone knows it!
>
> Any help appreciated. Many thanks in advance,
> Gernot
> --
> Gernot Hassenpflug
> _______________________________________________
> Merb-devel mailing list
> Merb-devel at rubyforge.org
> http://rubyforge.org/mailman/listinfo/merb-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://rubyforge.org/pipermail/merb-devel/attachments/20090511/b909892b/attachment.html>

On Tue, May 12, 2009 at 7:54 AM, Matt Aimonetti <mattaimonetti at
gmail.com> wrote:
> I didn''t check on the rdoc generator, but I think it was
contributed by Rob
> Kaufman if I remember correctly. Nothing will break if you remove the rdoc
> directory, so feel free to remove it if it gives you problems.
>
> you might want to join the google groups mailing list:
> http://groups.google.com/group/merb since very few people check on the RF
> mailing list.
>
> - Matt
Dear Matt, thank you very much for the helpful comments and advice. I
did remove the files and used rdoc successfully after copying
stylesheets etc. over from the older merb app. I will join the google
group---I had no idea which was the main forum to try in.

Best regards,
Gernot