Skip to content

Commit

Permalink
Docs: remove outdated notes on Windows compatibility (#382)
Browse files Browse the repository at this point in the history
* Docs: remove outdated notes on Windows compatibility

Closes #379

* Docs: add Python Launcher notes to config section
  • Loading branch information
brechtm authored Feb 10, 2021
1 parent d6a0ba5 commit a70df3c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 18 deletions.
11 changes: 10 additions & 1 deletion docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,23 @@ Configuring a session's virtualenv

By default, Nox will create a new virtualenv for each session using the same interpreter that Nox uses. If you installed Nox using Python 3.6, Nox will use Python 3.6 by default for all of your sessions.

You can tell Nox to use a different Python interpreter/version by specifying the ``python`` argument (or its alias ``py``) to ``@nox.session``:
You can tell Nox to use a different Python interpreter/version by specifying the ``python`` argument (or its alias ``py``) to ``@nox.session``:

.. code-block:: python
@nox.session(python='2.7')
def tests(session):
pass
.. note::

The Python binaries on Windows are found via the Python `Launcher`_ for
Windows (``py``). For example, Python 3.9 can be found by determining which
executable is invoked by ``py -3.9``. If a given test needs to use the 32-bit
version of a given Python, then ``X.Y-32`` should be used as the version.

.. _Launcher: https://docs.python.org/3/using/windows.html#python-launcher-for-windows

You can also tell Nox to run your session against multiple Python interpreters. Nox will create a separate virtualenv and run the session for each interpreter you specify. For example, this session will run twice - once for Python 2.7 and once for Python 3.6:

.. code-block:: python
Expand Down
17 changes: 0 additions & 17 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -346,23 +346,6 @@ You can output a report in ``json`` format by specifying ``--report``:
nox --report status.json
Windows
-------

Nox has provisional support for running on Windows. However, depending on your Windows, Python, and virtualenv versions there may be issues. See the following threads for more info:

* `tox issue 260 <https://github.com/tox-dev/tox/issues/260>`_
* `Python issue 24493 <http://bugs.python.org/issue24493>`_
* `Virtualenv issue 774 <https://github.com/pypa/virtualenv/issues/774>`_

The Python binaries on Windows are found via the Python `Launcher`_ for
Windows (``py``). For example, Python 3.5 can be found by determining which
executable is invoked by ``py -3.5``. If a given test needs to use the 32-bit
version of a given Python, then ``X.Y-32`` should be used as the version.

.. _Launcher: https://docs.python.org/3/using/windows.html#python-launcher-for-windows


Converting from tox
-------------------

Expand Down

0 comments on commit a70df3c

Please sign in to comment.