Skip to content

ogeidix/yard-spec-plugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

YARD-RSpec: A YARD extension for RSpec

YARD-Rspec is a YARD plugin that processes specs files and includes them in the documentation.

This release takes the work started by @lsegal and @kputnam and expands it with the support for:

Installation

To install this release add this line to your application's Gemfile:

gem 'yard-spec-plugin', :git => 'https://github.com/ogeidix/yard-spec-plugin.git', :tag => 'v0.2'

Execute:

$ bundle

Then edit the file .yardopts with

"{lib,app}/**/*.rb" "spec/{models,controllers,routing,mailers,lib,observers}/**/*.rb"  --plugin rspec

Usage

Now you can execure yard doc with

bundle exec yard doc

About

YARD Plugin example that documents RSpec code (live example in homepage)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%