improve documentation for install_command

This fixes #2081.
tox-dev · Jul 20, 2021 · 5d5f1f8 · 5d5f1f8
1 parent b35565a
commit 5d5f1f8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/changelog/2081.doc.rst b/docs/changelog/2081.doc.rst
@@ -0,0 +1 @@
+The documentation of ``install_command`` now also mentions bash scripts - by :user:`jugmac00`
diff --git a/docs/config.rst b/docs/config.rst
@@ -306,6 +306,12 @@ Complete list of settings that you can put into ``testenv*`` sections:
     such as ``--pre`` (configured as ``pip_pre``) and potentially index-options from the
     deprecated :conf:`indexserver` option.
 
+    .. note::
+
+        You can also provide a bash script to the ``install_command``.
+        Please note, that the script must be executable,
+        and that this could mean that running `tox` is no longer platform independent.
+
 .. conf:: list_dependencies_command ^ ARGV ^ python -m pip freeze
 
     .. versionadded:: 2.4