###. Copyright (C) The Arvados Authors. All rights reserved. .... .... SPDX-License-Identifier: CC-BY-SA-3.0 h1. Arvados documentation This is the source code for "doc.arvados.org":http://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":https://dev.arvados.org/projects/arvados/wiki/Documentation. h2. Install dependencies
arvados/doc$ sudo apt-get install build-essential libcurl4-openssl-dev libgnutls28-dev libssl-dev arvados/doc$ bundle installTo generate the Python SDK documentation, these additional dependencies are needed:
arvados/doc$ sudo apt install python3-pip python3-venv arvados/doc$ python3 -m venv .venv arvados/doc$ .venv/bin/pip install pdocThen you must activate the virtualenv (e.g., run @. .venv/bin/activate@) before you run the @bundle exec rake@ commands below. h2. Generate HTML pages
arvados/doc$ bundle exec rakeAlternately, to make the documentation browsable on the local filesystem:
arvados/doc$ bundle exec rake generate baseurl=$PWD/.siteh2. Run linkchecker If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on your system, you can run it against the documentation:
arvados/doc$ bundle exec rake linkchecker baseurl=file://$PWD/.sitePlease note that this will regenerate your $PWD/.site directory. h2. Preview HTML pages
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=8000Preview the rendered pages at "http://localhost:8000":http://localhost:8000. h2. Publish HTML pages inside Workbench (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.comMake 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/doch2. Delete generated files
arvados/doc$ bundle exec rake realclean