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

[arvados.git] / doc / README.textile

diff --git a/doc/README.textile b/doc/README.textile
index 23a82fe5b115e25468666e23980008d497ef7d50..38a53cf7a28d20d7570be8fce9b99f1884afe0cc 100644 (file)
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -18,6 +18,23 @@ h2. 1. Generate HTML pages
 arvados/doc$ rake
 </pre>
 
+Alternately, to make the documentation browsable on the local filesystem:
+
+<pre>
+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>