Project

yard-mruby

0.01
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
yard-mrubysagmor/yard-mrubyHomepageDocumentationSource CodeBug TrackerWiki
Generate Yard documentation for MRuby projects.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
13,953
Stars
9
Forks
4
Watchers
3
 Releases
Current version
0.3.0
Total releases
6
First release
2015-09-23
Latest release
2017-01-27
 Issues
Open Issues
6
Closed Issues
5
Total Issues
11
Issue Closure Rate
45%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
5
Pull Request Acceptance Rate
83%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-01-06
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.10
rake
~> 10.0
rspec
>= 0

Runtime

yard
~> 0.9.0
 Project Readme

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.