Light Mode Dark Mode

RSpec Documentation

RSpec Documentation provides a simple but powerful system for generating Ruby documentation using RSpec, designed to help you ensure that all code examples in your documentation really work.

Here’s an example:

subject { 'my subject' }
it { eql 'my subject' }
"my subject"

And the Markdown that created it:

subject { 'my subject' }
it { eql 'my subject' }

See the Quickstart setup guide to build your first RSpec Documentation project.

Browse the Examples to get a better idea of the typical usage patterns.

Documentation generated by rspec-documentation