Document MRuby sources with YARD
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
lib
sample
spec
templates/default
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
yard-mruby.gemspec

README.md

yard-mruby

Gem Travis

This is a plugin that allows YARD to parse and generate documentation for MRuby sources as well as documenting it's C APIs.

It still has it's rough edges and missing features but you can see a sample from it's current state when executed on MRuby's core here

Usage

Install with rubygems

$ gem install yard-mruby

And execute mrbdoc to generate the docs

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 bundle exec rake install.

Contributing

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