How to generate documentation for models in rails application?

Question

I want to generate documentation for my rails application. The application has models with relationship(e.g. has_many relation) and I am looking for a way to generate documentation that shows the relation between models. Ideally, with some graphs those represent the relationships between models.

Is there a way to achieve this in rails 3.2x ?

score 2 · Accepted Answer · answered Mar 13 '13 at 11:56

2

Check out the rails-erd gem. It generates entity-relationship diagrams from your models.

The Rubymine IDE also does it on the fly, but it's not free.

answered Mar 13 '13 at 11:56

m_x

12,357
7
46
60

I meant something for free :) – amjad Mar 13 '13 at 12:48

How to generate documentation for models in rails application?

1 Answers1