Rebuild documentation using Rocco
Go to file
2011-11-13 14:28:15 +01:00
lib/guard Allow for run_on: [:start, :reload, :all, :change] option 2011-11-13 14:07:19 +01:00
spec Add run options tests 2011-11-13 14:16:09 +01:00
.gitignore initial release 2011-06-17 16:01:49 -04:00
.travis.yml update the template so the right files get watched 2011-06-18 18:20:49 -04:00
Gemfile clean things up 2011-08-04 11:25:12 -04:00
guard-rocco.gemspec fix things, oops 2011-06-18 15:33:21 -04:00
Guardfile fix things, oops 2011-06-18 15:33:21 -04:00
Rakefile more cleanup 2011-08-04 11:27:27 -04:00
README.md Update documentation to tidy things up and explain run_all option 2011-11-13 14:28:15 +01:00

It's a Guard for the Rocco documentation system!

# default values
guard 'rocco', :run_all => [:start, :change], :dir => 'doc', :stylesheet => 'http://jashkenas.github.com/docco/resources/docco.css' do
  watch(%r{^app/.*\.(rb|coffee)$})
  watch(%r{^lib/.*\.rb$})
end

Options:

  • :run_on specifies when to update the docs
    • :start - run on all documentation when the guard starts
    • :change - run when watched files change
    • :reload - run when the guard is reloaded
    • :all - run when running all the guards
  • :dir specifies the output dir
  • :stylesheet specifies a custom stylesheet to use

gem install guard-rocco or Bundle it up with gem 'guard-rocco'. Then guard init rocco. Yeah!