20853: Modernize pdoc installation process

[arvados.git] / doc / README.textile

diff --git a/doc/README.textile b/doc/README.textile
index 0455171072cb144ae35bc9a7f528529550a358fd..9799ac564b42237a626331c090e7d43d3711711c 100644 (file)
--- 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:
 
 <pre>
-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
 </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@.
+
 h2. Generate HTML pages
 
 <pre>