Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
YARD Plugin example that documents RSpec code (live example in homepage)
Ruby
branch: master

This branch is 6 commits ahead of kputnam:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
example
lib
templates/default
.gitignore
LICENSE
README.md
Rakefile
yard-rspec.gemspec

README.md

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
Something went wrong with that request. Please try again.