# "how to" for documenting rails code?

**URL:** <https://www.ruby-forum.com/t/how-to-for-documenting-rails-code/114605>\
**Category:** Rails\
**Created:** [September 17, 2007, 11:59am UTC](https://www.ruby-forum.com/t/how-to-for-documenting-rails-code/114605 "2007-09-17T11:59:11Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![cmaxvv](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/c/85f322/32.png) [@cmaxvv](https://www.ruby-forum.com/u/cmaxvv)\
**Post date:** [September 17, 2007, 11:59am UTC](https://www.ruby-forum.com/t/how-to-for-documenting-rails-code/114605/1 "2007-09-17T11:59:11Z")

</div>

Can anyone point me at a guide for documenting your rails code? Ie how  
to format and produce some proper docs? The book i have (agile web dev  
with rails 2) says how to produce a version of the api but not your own  
stuff.

thanks