From 5eacdd4d7ad270ac40448e1c5fdb29c9ae65e7fd Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Mon, 29 Mar 2021 16:32:53 -0400 Subject: [PATCH] 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 --- doc/Rakefile | 10 ++++++++++ 1 file changed, 10 insertions(+) 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" -- 2.30.2