Add docs.watchr script

mynyml · Feb 7, 2010 · 29f0643 · 29f0643
1 parent 83c7087
commit 29f0643
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+doc/
+.yardoc/
diff --git a/docs.watchr b/docs.watchr
@@ -0,0 +1,25 @@
+# Run me with:
+#   $ watchr docs.watchr
+
+require 'yard'
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( 'lib/.*\.rb' ) { yard }
+watch( 'README.md'  ) { yard }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { yard        } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def yard
+  print "Updating yardocs... "; STDOUT.flush
+  YARD::CLI::Yardoc.run *%w( --no-highlight -o doc/yard --readme README.md - LICENSE )
+  print "done\n"
+end
+