21367: Add arvados virtualenv to $PATH

[arvados.git] / doc / README.textile

diff --git a/doc/README.textile b/doc/README.textile
index 75a30e9ef2ade8cfa04d8dec2e6275750a41047d..4c807a3dd61180d4d041bb729d6e0ab41dc0dff6 100644 (file)
--- a/doc/README.textile
+++ b/doc/README.textile
@@ -13,20 +13,30 @@ Additional information is available on the "'Documentation' page on the Arvados
 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 install python3-pip python3-venv
+arvados/doc$ python3 -m venv .venv
+arvados/doc$ .venv/bin/pip install pdoc
+</pre>
+
+Then you must activate the virtualenv (e.g., run @. .venv/bin/activate@) before you run the @bundle exec rake@ commands below.
+
 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
@@ -35,7 +45,7 @@ If you have "Linkchecker":http://wummel.github.io/linkchecker/ installed on
 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.
@@ -43,7 +53,7 @@ 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
@@ -58,17 +68,11 @@ h2. Publish HTML pages inside Workbench
 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
-</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.
-
-<pre>
-arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
+arvados/doc$ bundle exec rake generate baseurl=/doc arvados_api_host=xyzzy.arvadosapi.com
 </pre>
 
 h2. Delete generated files
 
 <pre>
-arvados/doc$ rake realclean
+arvados/doc$ bundle exec rake realclean
 </pre>