summaryrefslogtreecommitdiff
path: root/docs/config.rst
diff options
context:
space:
mode:
authorVlastimil Zíma <ziima@users.noreply.github.com>2022-12-16 16:09:41 +0100
committerGitHub <noreply@github.com>2022-12-16 07:09:41 -0800
commitfc9b36f37e63b2a9cd84d40eead3b2344ed966ca (patch)
tree7dd38ad8413fe535bd30182f9e3e82f458fbca6b /docs/config.rst
parent36ec2c0ce071f9605a50040d5a8aa508d62abd6b (diff)
downloadtox-git-fc9b36f37e63b2a9cd84d40eead3b2344ed966ca.tar.gz
Fix #2633 - Document user level config (#2736)
Diffstat (limited to 'docs/config.rst')
-rw-r--r--docs/config.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/config.rst b/docs/config.rst
index 3a17901c..0567b88a 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -750,3 +750,16 @@ Pip installer
If ``true``, adds ``--pre`` to the ``opts`` passed to :ref:`install_command`. This will cause it to install the
latest available pre-release of any dependencies without a specified version. If ``false``, pip will only install
final releases of unpinned dependencies.
+
+User configuration
+------------------
+
+tox allows creation of user level config-file to modify default values of the CLI commands.
+It is localted in the OS-specific user config directory under ``tox/config.ini`` path, see ``tox --help`` output for exact location.
+It can be changed via ``TOX_CONFIG_FILE`` environment variable.
+Example configuration:
+
+.. code-block:: ini
+
+ [tox]
+ skip_missing_interpreters = true