X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/8c65e73116254f49c2311dcb3f0685312d14d275..ee9d1e39b5d469a827be5a719c9c0860914ab2a8:/doc/README.textile diff --git a/doc/README.textile b/doc/README.textile index 0455171072..4c807a3dd6 100644 --- a/doc/README.textile +++ b/doc/README.textile @@ -20,11 +20,13 @@ 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 pdoc
+arvados/doc$ sudo apt install python3-pip python3-venv
+arvados/doc$ python3 -m venv .venv
+arvados/doc$ .venv/bin/pip install pdoc
 
+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
@@ -69,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
 
-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
-
- h2. Delete generated files