Contents

[![Code Climate](https://codeclimate.com/github/hzeus/doctest-rspec.png)](https://codeclimate.com/github/hzeus/doctest-rspec)
[![Build Status](https://travis-ci.org/hzeus/doctest-rspec.png)](https://travis-ci.org/hzeus/doctest-rspec)

# Doctest::RSpec

Add doctest to your rspec

## Installation

Add this line to your application's Gemfile:

    gem 'doctest-rspec'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install doctest-rspec

## Usage

Add doctest-formatted tests to your ruby files (see http://github.com/hzeus/doctest-extractor for syntax examples)

Configure RSpec:

```ruby
RSpec.configure do |c|
  c.extend Doctest::RSpec::DoctestHelpers
end
```

Add doctest:

```ruby
describe 'whatever' do
  doctest MyClassWithDoctests
end
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
doctest-rspec-0.0.2	README.md
doctest-rspec-0.0.1	README.md