itspriddle/rake-tomdoc

Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages

rake-tomdoc

Adds rake tomdoc to generate documentation for publishing to GitHub Pages.

Setup

Add this gem as a development dependency to your projects Gemfile or gemspec:

gem 'rake-tomdoc', group: :development

Gem::Specification.new do |s|
  ...
  s.add_development_dependency 'rake-tomdoc'
end

Create a gh-pages branch in your project. Make sure you have committed any changes and your repository contains no untracked files!

$ git checkout --orphan gh-pages
$ git rm -rf .
$ git commit --allow-empty -m "Created gh-pages branch"
$ git checkout -

Require the gem in your Rakefile:

require 'rake-tomdoc'

Usage

When you are ready to publish new documentation:

$ rake tomdoc [--trace]
$ git commit -am "Updating documentation"
$ git push origin gh-pages
$ git checkout -

Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Commit, do not bump version.
• Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2018 Joshua Priddle. See LICENSE for details.

rake-tomdoc's Issues

Bad docs generated under ruby 2.0.0p451

It seems something changed between ruby 2.0.0p353 and p451. Running rake tomdoc from p353 properly parses TomDoc but on p451 it does not.

I'm thinking that one of these gems' behaviors has changed somehow with the newer Ruby version:

• tomparse (0.4.2)
• yard (0.8.7.3)
• yard-tomdoc (0.7.1)

Yard was updated recently, but I have also verified that the older 0.8.7.1 release used at the time rake-tomdoc was published shows the same error on p451.

Here is the changelog between p353 and p451, nothing obvious stands out: https://gist.github.com/boone/8d9a0129121a114ffabe