doc: Add rake linkchecker task, and document it in the README file

diff --git a/doc/README.textile b/doc/README.textile
index f88d30435c20ff1af435e8e37f9340f80a03622d..38a53cf7a28d20d7570be8fce9b99f1884afe0cc 100644 (file)
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -24,6 +24,17 @@ Alternately, to make the documentation browsable on the local filesystem:
 arvados/doc$ rake generate baseurl=$PWD/.site
 </pre>
 
+h2. 2. Run linkchecker
+
+If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on
+your system, you can run it against the documentation:
+
+<pre>
+arvados/doc$ rake linkchecker baseurl=$PWD/.site
+</pre>
+
+Please note that this will regenerate your $PWD/.site directory.
+
 h2. 2. Preview HTML pages
 
 <pre>

diff --git a/doc/Rakefile b/doc/Rakefile
index d8af62f5e33b0bbae7a619044c3ce08739e01b0c..dbef7b97c5c6f1c285031305cb840fe8cb0f540f 100644 (file)
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -12,6 +12,22 @@ task :generate do
   end
 end
 
+task :linkchecker => [:realclean, :generate]
+
+task :linkchecker do
+  Dir.chdir(".site")
+  `which linkchecker`
+  if $? == 0
+    ignore_urls = ['', 'javascript', 'mailto',
+                   'oftc.net', 'putty.org','google.com', 'fsf.org',
+                   'arvadosapi.com', 'arvados.org', 'sourceforge.net',
+                   'chiark.greenend.org.uk', 'github.io' ]
+    system "linkchecker index.html " + ignore_urls.join(' --ignore-url=')
+  else
+    puts "Warning: linkchecker not found, skipping".colorize(:light_red)
+  end
+end
+
 require "zenweb/tasks"
 load "zenweb-textile.rb"
 load "zenweb-liquid.rb"