docs/installation: Add virtualenv --download flag

In Python 3.12, python -m venv seemingly no longer pulls in pip and setuptools, so switch to virtualenv instead `python setup.py develop` is now even more heavily discouraged, so use `pip install -e` instead
isso-comments · May 5, 2024 · 50de740 · 50de740
1 parent dc42c73
commit 50de740
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/docs/docs/contributing/documentation.rst b/docs/docs/contributing/documentation.rst
@@ -50,7 +50,7 @@ Install via pip:
 
 .. code-block:: console
 
-   $ virtualenv .venv && $ source .venv/bin/activate
+   $ virtualenv --download .venv && $ source .venv/bin/activate
    (.venv) $ pip install sphinx
    (.venv) $ sphinx-build --version
    ~> sphinx-build 4.5.0
@@ -157,7 +157,7 @@ Use ``.. code-block:: <language>`` and indent the code by one level:
    .. code-block:: console
 
         $ sudo apt install python3 python3-pip python3-virtualenv
-        $ virtualenv .venv
+        $ virtualenv --download .venv
         $ source .venv/bin/activate
         (.venv) $ python [cmd]
 

diff --git a/docs/docs/reference/installation.rst b/docs/docs/reference/installation.rst
@@ -48,7 +48,7 @@ but not recommended):
 
 .. code-block:: console
 
-    $ virtualenv /opt/isso
+    $ virtualenv --download /opt/isso
     $ source /opt/isso/bin/activate
 
 .. note::
@@ -216,7 +216,7 @@ To create a virtual environment (recommended), run:
 
 .. code-block:: console
 
-    $ virtualenv .venv
+    $ virtualenv --download .venv
     $ source .venv/bin/activate
 
 Install JavaScript modules using ``npm``:
@@ -235,7 +235,7 @@ Install Isso and its dependencies:
 
 .. code-block:: console
 
-    (.venv) $ python setup.py develop  # or `pip install -e .`
+    (.venv) $ pip install -e .  # -e = "editable" installation for development
     (.venv) $ isso -c /path/to/isso.cfg run
 
 .. _init-scripts:

diff --git a/docs/docs/technical-docs/testing-client.rst b/docs/docs/technical-docs/testing-client.rst
@@ -87,7 +87,7 @@ Start the server and ensure that the comment database is empty:
 .. code-block:: bash
 
    $ mv comments.db comments.db.bak
-   $ virtualenv .venv
+   $ virtualenv --download .venv
    $ source .venv/bin/activate
    (.venv) $ isso -c contrib/isso-dev.cfg run
 

diff --git a/docs/docs/technical-docs/testing.rst b/docs/docs/technical-docs/testing.rst
@@ -37,7 +37,7 @@ a development server available at ``localhost:8080``.
 
 .. code-block:: bash
 
-   $ virtualenv .venv
+   $ virtualenv --download .venv
    $ source .venv/bin/activate
    (.venv) $ isso -c contrib/isso-dev.cfg run