From: Ward Vandewege <ward@curii.com>
Date: Mon, 29 Mar 2021 20:32:53 +0000 (-0400)
Subject: Add a comment at the top of the documentation Rakefile about generating
X-Git-Tag: 2.2.0~85
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/5eacdd4d7ad270ac40448e1c5fdb29c9ae65e7fd

Add a comment at the top of the documentation Rakefile about generating
the docs locally.

refs #17245

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward@curii.com>
---

diff --git a/doc/Rakefile b/doc/Rakefile
index ee87062f7e..2b4b6af2e0 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"