Skip to content

Commit

Permalink
docs: update some links (#774)
Browse files Browse the repository at this point in the history
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
  • Loading branch information
henryiii committed Feb 21, 2024
1 parent e3d8578 commit 3b8e026
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

## Overview

`nox` is a command-line tool that automates testing in multiple Python environments, similar to [tox]. Unlike tox, Nox uses a standard Python file for configuration:
`nox` is a command-line tool that automates testing in multiple Python environments, similar to [tox][]. Unlike tox, Nox uses a standard Python file for configuration:

```python
import nox
Expand All @@ -41,19 +41,19 @@ def lint(session: nox.Session) -> None:

Nox is designed to be installed globally (not in a project virtual environment), the recommended way of doing this is via [pipx], a tool designed to install python CLI programs whilst keeping them separate from your global or system python.

To install Nox with [pipx]:
To install Nox with [pipx][]:

```shell
pipx install nox
```

You can also use [pip] in your global python:
You can also use [pip][] in your global python:

```shell
python3 -m pip install nox
```

You may want to user the [user-site] to avoid messing with your Global python install:
You may want to user the [user-site][] to avoid messing with your Global python install:

```shell
python3 -m pip install --user nox
Expand Down
22 changes: 16 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Welcome to Nox

``nox`` is a command-line tool that automates testing in multiple Python environments, similar to `tox`_. Unlike tox, Nox uses a standard Python file for configuration.

Install nox via `pip`_::
To install Nox with `pipx`_::

pip install --user --upgrade nox
pipx install nox

You can also use `pip`_ in your global python::

python3 -m pip install nox


Nox is configured via a ``noxfile.py`` file in your project's directory. Here's a simple noxfile that runs lint and some tests::
Expand All @@ -42,14 +46,15 @@ For each session, Nox will automatically create a `virtualenv`_ with the appropr
To learn how to install and use Nox, see the :doc:`tutorial`. For documentation on configuring sessions, see :doc:`config`. For documentation on running ``nox``, see :doc:`usage`.

.. _tox: https://tox.readthedocs.org
.. _pip: https://pip.readthedocs.org
.. _pip: https://pip.pypa.io
.. _pipx: https://pipx.pypa.io
.. _pytest: http://pytest.org
.. _virtualenv: https://virtualenv.readthedocs.org
.. _virtualenv: https://virtualenv.pypa.io

Projects that use Nox
---------------------

Nox is lucky to have several wonderful projects that use it and provide feedback and contributions.
Nox is lucky to have `over 3,000 <https://github.com/search?type=code&q=path%3Anoxfile.py+NOT+is%3Afork>`__ wonderful projects that use it and provide feedback and contributions. A few of them are:

- `Bézier <https://github.com/dhermes/bezier>`__
- `cibuildwheel <https://github.com/pypa/cibuildwheel>`__
Expand All @@ -59,16 +64,19 @@ Nox is lucky to have several wonderful projects that use it and provide feedback
- `google-cloud-python <https://github.com/googlecloudplatform/google-cloud-python>`__
- `google-resumable-media-python <https://github.com/GoogleCloudPlatform/google-resumable-media-python>`__
- `Hydra <https://hydra.cc>`__
- `Jupyter <https://github.com/jupyter/jupyter>`__
- `manylinux <https://github.com/pypa/manylinux>`__
- `OmegaConf <https://github.com/omry/omegaconf>`__
- `OpenCensus Python <https://github.com/census-instrumentation/opencensus-python>`__
- `packaging <https://github.com/pypa/packaging>`__
- `packaging.python.org <https://github.com/pypa/python-packaging-user-guide>`__
- `pip <https://github.com/pypa/pip>`__
- `pipx <https://github.com/pypa/pipx>`__
- `pybind11 <https://github.com/pybind/pybind11>`__
- `Salt <https://github.com/saltstack/salt>`__
- `Scikit-build <https://github.com/scikit-build/scikit-build>`__
- `Scikit-HEP <https://scikit-hep.org/developer/tasks>`__
- `Scikit-HEP <https://scikit-hep.org>`__
- `Scientific Python <https://github.com/scientific-python/cookie>`__
- `Subpar <https://github.com/google/subpar>`__
- `Urllib3 <https://github.com/urllib3/urllib3>`__
- `Zazo <https://github.com/pradyunsg/zazo>`__
Expand All @@ -80,6 +88,7 @@ Nox is not the only tool of its kind. If Nox doesn't quite fit your needs or you

- `tox <https://tox.readthedocs.org>`__ is the de-facto standard for managing multiple Python test environments, and is the direct spiritual ancestor to Nox.
- `Invoke <https://www.pyinvoke.org/>`__ is a general-purpose task execution library, similar to Make. Nox can be thought of as if Invoke were tailored specifically to Python testing, so Invoke is a great choice for scripts that need to encompass far more than Nox's specialization.
- `Hatch <https://hatch.pypa.io>`__ A modern, extensible Python project manager using ``pyproject.toml`` configuration and a scripts + environments approach.


Maintainers & contributors
Expand All @@ -93,6 +102,7 @@ Our maintainers are (in alphabetical order):
* `Claudio Jolowicz <https://github.com/cjolowicz>`__
* `Danny Hermes <https://github.com/dhermes>`__
* `Diego Ramirez <https://github.com/DiddiLeija>`__
* `Henry Schreiner <https://github.com/henryiii>`__
* `Luke Sneeringer <https://github.com/lukesneeringer>`__
* `Santos Gallegos <https://github.com/stsewd>`__
* `Thea Flowers <https://github.com/theacodes>`__
Expand Down

0 comments on commit 3b8e026

Please sign in to comment.