This plugin for Yard permits to generate the documentation about a Rails project.
This means to handle in the correct way things such models, controllers, routes and so on.
At now this plugin manages:
You are more than invited to contribute!
For now this gem is available only through github so add this line to your application's Gemfile:
gem 'yard-rails-plugin', :git => 'https://github.com/ogeidix/yard-rails-plugin.git', :tag => 'v0.0.1'
Execute:
$ bundle
Then edit the file .yardopts with
"{lib,app}/**/*.rb" --plugin rails-plugin - tmp/routes.html
Now you can execure yard doc with
bundle exec yard doc
To document a Rails project you can add other interesting plugins. I suggest you to checkout these: