+###. 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.
h2. Install dependencies
<pre>
+arvados/doc$ sudo apt-get install build-essential libcurl4-openssl-dev libgnutls28-dev libssl-dev
arvados/doc$ bundle install
-arvados/doc$ pip install epydoc
+</pre>
+
+To generate the Python SDK documentation, these additional dependencies are needed:
+
+<pre>
+arvados/doc$ sudo apt-get install python3-pip
+arvados/doc$ pip3 install arvados-python-client
+arvados/doc$ pip3 install pdoc3
</pre>
h2. Generate HTML pages
<pre>
-arvados/doc$ rake
+arvados/doc$ bundle exec rake
</pre>
Alternately, to make the documentation browsable on the local filesystem:
<pre>
-arvados/doc$ rake generate baseurl=$PWD/.site
+arvados/doc$ bundle exec rake generate baseurl=$PWD/.site
</pre>
h2. Run linkchecker
your system, you can run it against the documentation:
<pre>
-arvados/doc$ rake linkchecker baseurl=file://$PWD/.site
+arvados/doc$ bundle exec rake linkchecker baseurl=file://$PWD/.site
</pre>
Please note that this will regenerate your $PWD/.site directory.
h2. Preview HTML pages
<pre>
-arvados/doc$ rake run
+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
(or some other web site)
-You can set @baseurl@ (the URL prefix for all internal links), @arvados_api_host@ and @arvados_workbench_host@ without changing @_config.yml@:
+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@:
<pre>
-arvados/doc$ rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
+arvados/doc$ bundle exec rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
</pre>
Make the docs appear at {workbench_host}/doc by creating a symbolic link in Workbench's @public@ directory, pointing to the generated HTML tree.
h2. Delete generated files
<pre>
-arvados/doc$ rake realclean
+arvados/doc$ bundle exec rake realclean
</pre>