https://github.com/kmoschcau/yard-sequel

A Ruby Yard Documentation plugin for the Sequel Gem
https://github.com/kmoschcau/yard-sequel

ruby ruby-gem rubygem rubygems sequel yard-documentation yard-sequel

Last synced: about 1 year ago
JSON representation

A Ruby Yard Documentation plugin for the Sequel Gem

• Host: GitHub
• URL: https://github.com/kmoschcau/yard-sequel
• Owner: kmoschcau
• License: mit
• Created: 2016-12-24T13:06:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-02T06:08:38.000Z (over 7 years ago)
• Last Synced: 2024-03-15T01:23:07.873Z (about 2 years ago)
• Topics: ruby, ruby-gem, rubygem, rubygems, sequel, yard-documentation, yard-sequel
• Language: Ruby
• Size: 75.2 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Gem Version](https://badge.fury.io/rb/yard-sequel.svg)](https://badge.fury.io/rb/yard-sequel)

[![Build Status](https://travis-ci.org/kmoschcau/yard-sequel.svg?branch=master)](https://travis-ci.org/kmoschcau/yard-sequel)

[![Code Climate](https://codeclimate.com/github/kmoschcau/yard-sequel/badges/gpa.svg)](https://codeclimate.com/github/kmoschcau/yard-sequel)

[![Coverage Status](https://coveralls.io/repos/github/kmoschcau/yard-sequel/badge.svg?branch=master)](https://coveralls.io/github/kmoschcau/yard-sequel?branch=master)

[![Inline docs](http://inch-ci.org/github/kmoschcau/yard-sequel.svg?branch=master&style=shields)](http://inch-ci.org/github/kmoschcau/yard-sequel)

[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/kmoschcau/yard-sequel/master)

# 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](http://contributor-covenant.org) code of

conduct.

## License

The gem is available as open source under the terms of the

[MIT License](http://opensource.org/licenses/MIT).