Add a comment at the top of the documentation Rakefile about generating

[arvados.git] / doc / Rakefile

diff --git a/doc/Rakefile b/doc/Rakefile
index ee87062f7ec275716f454c298db96eb9239e0e0a..2b4b6af2e0cb2385a95835033fc69c90c5dd8ce3 100644 (file)
--- 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"