This gem provides
gem yardoc command which generates YARD documentations for specified gems.
$ gem install rubygems-yardoc
Installing Redcarpet by:
$ gem install redcarpet
often helps you because many gems use Markdown to write README files and YARD requires Redcarpet when parsing Markdown.
$ gem yardoc GEMNAME [GEMNAME ...]
yardoc directory into specified gem's doc directory and
YARD Documentation for the gem will be generated into the directory.
And this gem add
--yardoc option to
gem install command
which install YARD documentation.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request