X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/38104975556f7a0a59c1a21a97aa37cd0e178d69..451559bf80f31f57ac6937e79e4d37633b9eafa3:/doc/Rakefile

diff --git a/doc/Rakefile b/doc/Rakefile
index ee87062f7e..4427f7822e 100644
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -8,6 +8,16 @@
 # generating the documentation for the SDKs, which (the R docs
 # especially) take a fair bit of time and slow down the edit-preview
 # cycle.
+#
+# To generate and view the documentation locally, run this command
+#
+#   rake && sensible-browser .site/index.html
+#
+# Or alternatively:
+#
+#   baseurl=http://localhost:8000 rake && rake run
+#
+# and then visit http://localhost:8000 in a browser.
 
 require "rubygems"
 require "colorize"
@@ -150,7 +160,8 @@ task :linkchecker => [ :generate ] do
   Dir.chdir(".site") do
     `which linkchecker`
     if $? == 0
-      system "linkchecker index.html --ignore-url='!file://'" or exit $?.exitstatus
+      # we need --check-extern to check relative links, weird but true
+      system "linkchecker index.html --check-extern --ignore-url='!file://'" or exit $?.exitstatus
     else
       puts "Warning: linkchecker not found, skipping run".colorize(:light_red)
     end