Skip to content

Commit d530ba1

Browse files
henryiiibhrutledge
andauthored
chore: nicer nox help text (#1128)
Signed-off-by: Henry Schreiner <[email protected]> Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: Brian Rutledge <[email protected]>
1 parent 1834a85 commit d530ba1

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

noxfile.py

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,15 @@
66
import shutil
77
import nox
88

9-
@nox.session(py="3")
9+
10+
nox.options.sessions = []
11+
12+
13+
@nox.session()
1014
def translation(session):
15+
"""
16+
Build the gettext .pot files.
17+
"""
1118
session.install("-r", "requirements.txt")
1219
target_dir = "locales"
1320
session.run(
@@ -18,8 +25,11 @@ def translation(session):
1825
target_dir, # where to put the .pot file
1926
)
2027

21-
@nox.session(py="3")
28+
@nox.session()
2229
def build(session, autobuild=False):
30+
"""
31+
Make the website.
32+
"""
2333
session.install("-r", "requirements.txt")
2434

2535
target_build_dir = "build"
@@ -49,14 +59,20 @@ def build(session, autobuild=False):
4959
)
5060

5161

52-
@nox.session(py="3")
62+
@nox.session()
5363
def preview(session):
64+
"""
65+
Make and preview the website.
66+
"""
5467
session.install("sphinx-autobuild")
5568
build(session, autobuild=True)
5669

5770

58-
@nox.session(py="3")
71+
@nox.session()
5972
def linkcheck(session):
73+
"""
74+
Check for broken links.
75+
"""
6076
session.install("-r", "requirements.txt")
6177
session.run(
6278
"sphinx-build",

0 commit comments

Comments
 (0)