YARD::Mongoid

Gem Version Build Status Dependency Status Code Climate Test Coverage

A YARD plugin for documenting Mongoid models.

Installation

Add this line to your application's Gemfile:

gem 'yard-mongoid'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yard-mongoid

Usage

Add following line to .yardopts:

--plugin mongoid

or use it as argument to yard doc command like yard doc --plugin mongoid.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bin/rake install. To release a new version, update the version number in version.rb, and then run bin/rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alsemyonov/yard-mongoid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

© Alex Semyonov <alex@semyonov.us>, 2016

The gem is available as open source under the terms of the MIT License.