###. Copyright © The Arvados Authors. All rights reserved.
….
…. SPDX-License-Identifier: CC-BY-SA-3.0
This is the source code for doc.arvados.org.
Here’s how to build the HTML pages locally so you can preview your updates before you commit and push.
Additional information is available on the ‘Documentation’ page on the Arvados wiki.
arvados/doc$ sudo apt-get install build-essential libcurl4-openssl-dev libgnutls28-dev libssl-dev arvados/doc$ bundle install
To generate the Python SDK documentation, these additional dependencies are needed:
arvados/doc$ sudo apt-get install python3-pip arvados/doc$ pip3 install arvados-python-client arvados/doc$ pip3 install pdoc3
arvados/doc$ bundle exec rake
Alternately, to make the documentation browsable on the local filesystem:
arvados/doc$ bundle exec rake generate baseurl=$PWD/.site
If you have Linkchecker installed on
your system, you can run it against the documentation:
arvados/doc$ bundle exec rake linkchecker baseurl=file://$PWD/.site
Please note that this will regenerate your $PWD/.site directory.
arvados/doc$ bundle exec 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
Preview the rendered pages at http://localhost:8000.
(or some other web site)
You can set baseurl (the URL prefix for all internal links), arvados_cluster_uuid, arvados_api_host and arvados_workbench_host without changing _config.yml:
arvados/doc$ bundle exec rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
Make the docs appear at {workbench_host}/doc by creating a symbolic link in Workbench’s public directory, pointing to the generated HTML tree.
arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
arvados/doc$ bundle exec rake realclean