X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d26fce5afa74c38a094409867c18f6973512e439..876b9e64d1364770486552060222f5f6b1b5e2ea:/doc/Rakefile 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"