Rebuild documentation using Rocco
76f781ec08
it's a preference of mine, but I guess we shouldn't bother people with long lines of code when they are the default anyway. |
||
|---|---|---|
| lib/guard | ||
| spec | ||
| .gitignore | ||
| .travis.yml | ||
| Gemfile | ||
| guard-rocco.gemspec | ||
| Guardfile | ||
| Rakefile | ||
| README.md | ||
It's a Guard for the Rocco documentation system!
# default values
guard 'rocco', :run_on => [: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_onspecifies 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
:dirspecifies the output dir:stylesheetspecifies a custom stylesheet to use
gem install guard-rocco or Bundle it up with gem 'guard-rocco'. Then guard init rocco. Yeah!