Arvados Documentation

0. Install dependencies

  $ bundle install


1. To build or update documentation:
  $ rake generate


2. To view documentation:
  $ rake run
[2014-03-10 09:03:41] INFO  WEBrick 1.3.1
[2014-03-10 09:03:41] INFO  ruby 2.1.1 (2014-02-24) [x86_64-linux]
[2014-03-10 09:03:41] INFO  WEBrick::HTTPServer#start: pid=8926 port=8000

  Then go to http://localhost:8000


2. You can set 'baseurl' (the URL prefix for all internal links),
'arvados_api_host' and 'arvados_workbench_host' without changing _config.yml:

 $ rake generate baseurl=/example arvados_api_host=example.com


4. To delete generated files:
  $ rake realclean