doc/README

   1 Arvados Documentation
   2
   3 0. Install dependencies
   4
   5   $ bundle install
   6
   7
   8 1. To build or update documentation:
   9   $ rake generate
  10
  11
  12 2. To view documentation:
  13   $ rake run
  14 [2014-03-10 09:03:41] INFO  WEBrick 1.3.1
  15 [2014-03-10 09:03:41] INFO  ruby 2.1.1 (2014-02-24) [x86_64-linux]
  16 [2014-03-10 09:03:41] INFO  WEBrick::HTTPServer#start: pid=8926 port=8000
  17
  18   Then go to http://localhost:8000
  19
  20
  21 2. You can set 'baseurl' (the URL prefix for all internal links),
  22 'arvados_api_host' and 'arvados_workbench_host' without changing _config.yml:
  23
  24  $ rake generate baseurl=/example arvados_api_host=example.com
  25
  26
  27 4. To delete generated files:
  28   $ rake realclean