Skip to content

Commit 3b8e026

Browse files
authored
docs: update some links (#774)
Signed-off-by: Henry Schreiner <[email protected]>
1 parent e3d8578 commit 3b8e026

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
## Overview
2222

23-
`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:
23+
`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:
2424

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

4242
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.
4343

44-
To install Nox with [pipx]:
44+
To install Nox with [pipx][]:
4545

4646
```shell
4747
pipx install nox
4848
```
4949

50-
You can also use [pip] in your global python:
50+
You can also use [pip][] in your global python:
5151

5252
```shell
5353
python3 -m pip install nox
5454
```
5555

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

5858
```shell
5959
python3 -m pip install --user nox

docs/index.rst

+16-6
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Welcome to Nox
1414

1515
``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.
1616

17-
Install nox via `pip`_::
17+
To install Nox with `pipx`_::
1818

19-
pip install --user --upgrade nox
19+
pipx install nox
20+
21+
You can also use `pip`_ in your global python::
22+
23+
python3 -m pip install nox
2024

2125

2226
Nox is configured via a ``noxfile.py`` file in your project's directory. Here's a simple noxfile that runs lint and some tests::
@@ -42,14 +46,15 @@ For each session, Nox will automatically create a `virtualenv`_ with the appropr
4246
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`.
4347

4448
.. _tox: https://tox.readthedocs.org
45-
.. _pip: https://pip.readthedocs.org
49+
.. _pip: https://pip.pypa.io
50+
.. _pipx: https://pipx.pypa.io
4651
.. _pytest: http://pytest.org
47-
.. _virtualenv: https://virtualenv.readthedocs.org
52+
.. _virtualenv: https://virtualenv.pypa.io
4853

4954
Projects that use Nox
5055
---------------------
5156

52-
Nox is lucky to have several wonderful projects that use it and provide feedback and contributions.
57+
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:
5358

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

8189
- `tox <https://tox.readthedocs.org>`__ is the de-facto standard for managing multiple Python test environments, and is the direct spiritual ancestor to Nox.
8290
- `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.
91+
- `Hatch <https://hatch.pypa.io>`__ A modern, extensible Python project manager using ``pyproject.toml`` configuration and a scripts + environments approach.
8392

8493

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

0 commit comments

Comments
 (0)