Skip to content

Commit

Permalink
Implement string replacement
Browse files Browse the repository at this point in the history
Signed-off-by: Bernát Gábor <[email protected]>
  • Loading branch information
gaborbernat committed Oct 1, 2024
1 parent ee45435 commit 6ee72ca
Show file tree
Hide file tree
Showing 28 changed files with 1,671 additions and 825 deletions.
708 changes: 535 additions & 173 deletions docs/config.rst

Large diffs are not rendered by default.

47 changes: 29 additions & 18 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,42 @@
Installation
============

via pipx
As tool
--------

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

.. code-block:: bash
.. tab:: uv

python -m pip install pipx-in-pipx --user
pipx install tox
tox --help
.. code-block:: bash
via pip
-------
# install uv per https://docs.astral.sh/uv/#getting-started
uv tool install tox
tox --help
Alternatively you can install it within the global Python interpreter itself (perhaps as a user package via the
``--user`` flag). Be cautious if you are using a Python installation that is managed by your operating system or
another package manager. ``pip`` might not coordinate with those tools, and may leave your system in an inconsistent
state. Note, if you go down this path you need to ensure pip is new enough per the subsections below:
.. code-block:: bash
.. tab:: pipx

.. code-block:: bash
python -m pip install pipx-in-pipx --user
pipx install tox
tox --help
.. tab:: pip

.. code-block:: bash
python -m pip install --user tox
python -m tox --help
python -m pip install --user tox
python -m tox --help
You can install it within the global Python interpreter itself (perhaps as a user package via the
``--user`` flag). Be cautious if you are using a Python installation that is managed by your operating system or
another package manager. ``pip`` might not coordinate with those tools, and may leave your system in an inconsistent
state. Note, if you go down this path you need to ensure pip is new enough per the subsections below

wheel
~~~~~
Expand Down Expand Up @@ -66,7 +77,7 @@ Python and OS Compatibility

tox works with the following Python interpreter implementations:

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

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

0 comments on commit 6ee72ca

Please sign in to comment.