Gem Version Build Status Dependency Status Code Climate Coverage Status Inline docs Yard Docs

yard-sequel

A plugin for the Yard documentation tool to automatically document Sequel code.

Installation

Install it as:

$ gem install yard-sequel

Usage

Install the gem on the system you generate documentation on and enable plugins or just this plugin in your ~/.yard/config.

Development

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kmoschcau/yard-sequel. 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

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