From: Brett Smith <brett.smith@curii.com>
Date: Mon, 14 Aug 2023 21:04:10 +0000 (-0400)
Subject: 20853: Modernize pdoc installation process
X-Git-Tag: 2.7.0~29^2
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/6214997f9c61b40e25a31b9ca7d6b63b9a158837?hp=8c65e73116254f49c2311dcb3f0685312d14d275

20853: Modernize pdoc installation process

Install to a virtualenv to accommodate PEP 668.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>
---

diff --git a/doc/README.textile b/doc/README.textile
index 0455171072..9799ac564b 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:
 
 <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>