Is there an auto documentor for a rails app like php documentor (http://www.phpdoc.org/)? I''m in need of an auto documentation engine. Any recommendations would be great. Thanks, Matt --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
On 18 Dec 2008, at 18:06, matt simp wrote:> > Is there an auto documentor for a rails app like php documentor > (http://www.phpdoc.org/)? I''m in need of an auto documentation > engine. > > Any recommendations would be great.as in rdoc ? Fred> > > Thanks, > Matt > >--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
Yes, but not just for ruby source, but specifically for a rails application. Supporting the directory structure of an app. So that the documentation would be rendered with output of an applications structure in mind. On Dec 18, 12:12 pm, Frederick Cheung <frederick.che...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> On 18 Dec 2008, at 18:06, matt simp wrote: > > > > > Is there an auto documentor for a rails app like php documentor > > (http://www.phpdoc.org/)? I''m in need of an auto documentation > > engine. > > > Any recommendations would be great. > > as in rdoc ? > > Fred > > > > > Thanks, > > Matt--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
What I mean is rdoc does an excellent job with ruby source code, is there anything out there that has merged the rdoc capabilities with all "rails app" source files and structure? When working with a larger scale application it''s essential to be able to make documentation notes on almost every file, currently this is not possible because the views are missing out, this is especially nice when the application is dealing with a lot of partials throughout the view, rather than reading through embedded comments, it would be generated into the docs along with the ruby source docs. I''m just curious if anyone has developed anything like this yet. Thanks On Dec 18, 12:18 pm, Matt Simpson <matt.simps...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> Yes, but not just for ruby source, but specifically for a rails > application. Supporting the directory structure of an app. So that > the documentation would be rendered with output of an applications > structure in mind. > > On Dec 18, 12:12 pm, Frederick Cheung <frederick.che...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> > wrote: > > > On 18 Dec 2008, at 18:06, matt simp wrote: > > > > Is there an auto documentor for a rails app like php documentor > > > (http://www.phpdoc.org/)? I''m in need of an auto documentation > > > engine. > > > > Any recommendations would be great. > > > as in rdoc ? > > > Fred > > > > Thanks, > > > Matt--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
On Thursday 18 December 2008 16:35:25 Matt Simpson wrote:> What I mean is rdoc does an excellent job with ruby sourcecode, is> there anything out there that has merged the rdoccapabilities with> all "rails app" source files and structure? >"rake doc:*" didn''t fit your needs? hth, -- Davi Vidal -- E-mail: davividal arroba siscompar ponto com ponto br MSN : davividal arroba msn ponto com GTalk : davividal arroba gmail ponto com Skype : davividal YIM : davi_vidal ICQ : 138815296 --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
I had to use rdoc --exclude templates shouldn''t a template file have a different extension than *.rb? On Dec 18, 12:18 pm, Matt Simpson <matt.simps...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> Yes, but not just for ruby source, but specifically for a rails > application. Supporting the directory structure of an app. So that > the documentation would be rendered with output of an applications > structure in mind. > > On Dec 18, 12:12 pm, Frederick Cheung <frederick.che...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> > wrote: > > > On 18 Dec 2008, at 18:06, matt simp wrote: > > > > Is there an auto documentor for a rails app like php documentor > > > (http://www.phpdoc.org/)? I''m in need of an auto documentation > > > engine. > > > > Any recommendations would be great. > > > as in rdoc ? > > > Fred > > > > Thanks, > > > Matt--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---
i''ll try that rake task. Thanks On Dec 18, 1:26 pm, Matt Simpson <matt.simps...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> I had to use rdoc --exclude templates > > shouldn''t a template file have a different extension than *.rb? > > On Dec 18, 12:18 pm, Matt Simpson <matt.simps...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote: > > > Yes, but not just for ruby source, but specifically for a rails > > application. Supporting the directory structure of an app. So that > > the documentation would be rendered with output of an applications > > structure in mind. > > > On Dec 18, 12:12 pm, Frederick Cheung <frederick.che...-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> > > wrote: > > > > On 18 Dec 2008, at 18:06, matt simp wrote: > > > > > Is there an auto documentor for a rails app like php documentor > > > > (http://www.phpdoc.org/)? I''m in need of an auto documentation > > > > engine. > > > > > Any recommendations would be great. > > > > as in rdoc ? > > > > Fred > > > > > Thanks, > > > > Matt--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group. To post to this group, send email to rubyonrails-talk-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en -~----------~----~----~----~------~----~------~--~---