Skip to content

Commit 40b0ff5

Browse files
Add notes about nox and noxfile.py
Co-authored-by: Chris Holdgraf <[email protected]>
1 parent 89d84fe commit 40b0ff5

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ The JupyterHub team also maintains analysis of binder data including [billing da
2727
## Build the documentation
2828

2929
This documentation is built with [the Sphinx Documentation engine]().
30-
The easiest way to build the documentation is with `nox`.
31-
`nox` is a way to automatically install environments and run commands locally.
30+
The easiest way to build the documentation is with [the tool `nox`](https://nox.thea.codes/en/stable/).
31+
`nox` is kind-of like a Makefile, it is a way to automatically install environments and run commands locally.
3232
To build this documentation with `nox`, run:
3333

3434
```bash

noxfile.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""A nox configuration file so that we can build the documentation easily with nox.
2+
- see the README.md for information about nox.
3+
- ref: https://nox.thea.codes/en/stable/
4+
"""
15
import nox
26
from pathlib import Path
37

0 commit comments

Comments
 (0)