Skip to content

Commit 6ee72ca

Browse files
committed
Implement string replacement
Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
1 parent ee45435 commit 6ee72ca

28 files changed

+1671
-825
lines changed

docs/config.rst

Lines changed: 535 additions & 173 deletions
Large diffs are not rendered by default.

docs/installation.rst

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,42 @@
11
Installation
22
============
33

4-
via pipx
4+
As tool
55
--------
66

7-
:pypi:`tox` is a CLI tool that needs a Python interpreter (version 3.7 or higher) to run. We recommend :pypi:`pipx` to
8-
install tox into an isolated environment. This has the added benefit that later you'll be able to upgrade tox without
9-
affecting other parts of the system.
7+
:pypi:`tox` is a CLI tool that needs a Python interpreter (version 3.7 or higher) to run. We recommend either
8+
:pypi:`pipx` or :pypi:`ruff` to install tox into an isolated environment. This has the added benefit that later you'll
9+
be able to upgrade tox without affecting other parts of the system. We provide method for ``pip`` too here but we
10+
discourage that path if you can:
1011

11-
.. code-block:: bash
12+
.. tab:: uv
1213

13-
python -m pip install pipx-in-pipx --user
14-
pipx install tox
15-
tox --help
14+
.. code-block:: bash
1615
17-
via pip
18-
-------
16+
# install uv per https://docs.astral.sh/uv/#getting-started
17+
uv tool install tox
18+
tox --help
1919
20-
Alternatively you can install it within the global Python interpreter itself (perhaps as a user package via the
21-
``--user`` flag). Be cautious if you are using a Python installation that is managed by your operating system or
22-
another package manager. ``pip`` might not coordinate with those tools, and may leave your system in an inconsistent
23-
state. Note, if you go down this path you need to ensure pip is new enough per the subsections below:
2420
25-
.. code-block:: bash
21+
.. tab:: pipx
22+
23+
.. code-block:: bash
24+
25+
python -m pip install pipx-in-pipx --user
26+
pipx install tox
27+
tox --help
28+
29+
.. tab:: pip
30+
31+
.. code-block:: bash
32+
33+
python -m pip install --user tox
34+
python -m tox --help
2635
27-
python -m pip install --user tox
28-
python -m tox --help
36+
You can install it within the global Python interpreter itself (perhaps as a user package via the
37+
``--user`` flag). Be cautious if you are using a Python installation that is managed by your operating system or
38+
another package manager. ``pip`` might not coordinate with those tools, and may leave your system in an inconsistent
39+
state. Note, if you go down this path you need to ensure pip is new enough per the subsections below
2940

3041
wheel
3142
~~~~~
@@ -66,7 +77,7 @@ Python and OS Compatibility
6677

6778
tox works with the following Python interpreter implementations:
6879

69-
- `CPython <https://www.python.org/>`_ versions 3.7, 3.8, 3.9, 3.10, 3.11, 3.12
80+
- `CPython <https://www.python.org/>`_ versions 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
7081

7182
This means tox works on the latest patch version of each of these minor versions. Previous patch versions are supported
7283
on a best effort approach.

0 commit comments

Comments
 (0)