21367: Add arvados virtualenv to $PATH
[arvados.git] / doc / README.textile
index 9799ac564b42237a626331c090e7d43d3711711c..4c807a3dd61180d4d041bb729d6e0ab41dc0dff6 100644 (file)
@@ -25,7 +25,7 @@ arvados/doc$ python3 -m venv .venv
 arvados/doc$ .venv/bin/pip install pdoc
 </pre>
 
-Then the generation process will need to be able to find @arvados/doc/.venv/bin/pdoc@. Either add that full directory to your @$PATH@, or make a @pdoc@ symlink in another directory that's already in your @$PATH@.
+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
 
@@ -71,12 +71,6 @@ You can set @baseurl@ (the URL prefix for all internal links), @arvados_cluster_
 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.
-
-<pre>
-arvados/doc$ ln -sn ../../../doc/.site ../apps/workbench/public/doc
-</pre>
-
 h2. Delete generated files
 
 <pre>