# Rails Auto Documentor?

**URL:** <https://www.ruby-forum.com/t/rails-auto-documentor/155973>\
**Category:** Rails\
**Created:** [December 18, 2008, 7:07pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973 "2008-12-18T19:07:14Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 7:07pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/1 "2008-12-18T19:07:14Z")

</div>

Is there an auto documentor for a rails app like php documentor  
([http://www.phpdoc.org/](http://www.phpdoc.org/))? I’m in need of an auto documentation  
engine.

Any recommendations would be great.

Thanks,  
Matt

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 7:13pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/2 "2008-12-18T19:13:07Z")

</div>

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/](http://www.phpdoc.org/))? I’m in need of an auto documentation  
> engine.
> 
> Any recommendations would be great.

as in rdoc ?

Fred

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 7:21pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/3 "2008-12-18T19:21:20Z")

</div>

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 C. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 7:35pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/4 "2008-12-18T19:35:59Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 8:27pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/5 "2008-12-18T20:27:03Z")

</div>

I had to use rdoc --exclude templates

shouldn’t a template file have a different extension than \*.rb?

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 8:28pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/6 "2008-12-18T20:28:13Z")

</div>

i’ll try that rake task.

Thanks

---

<div class="post-metadata">

**Author:** ![matt\_simp](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/a698b9/32.png) [@matt\_simp](https://www.ruby-forum.com/u/matt_simp)\
**Post date:** [December 18, 2008, 8:11pm UTC](https://www.ruby-forum.com/t/rails-auto-documentor/155973/7 "2008-12-18T20:11:13Z")

</div>

On Thursday 18 December 2008 16:35:25 Matt Simpson wrote:

> 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?

“rake doc:\*” didn’t fit your needs?

## hth,

## Davi V.

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