No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
templates/default
.gitignore
Gemfile
LICENSE
README.md
Rakefile
yard-rails-plugin.gemspec

README.md

Yard::Rails::Plugin

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:

  • Routes
    • creates a summary file
    • adds to each controller and action its routes
  • Controller Params
    • adds to each action a list of params taken

You are more than invited to contribute!

Installation

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

Usage

Now you can execure yard doc with

bundle exec yard doc

Other useful yard plugins

To document a Rails project you can add other interesting plugins. I suggest you to checkout these: