forked from pypa/packaging.python.org
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnoxfile.py
More file actions
106 lines (91 loc) · 2.54 KB
/
noxfile.py
File metadata and controls
106 lines (91 loc) · 2.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# Copyright 2017, PyPA
# The Python Packaging User Guide is licensed under a Creative Commons
# Attribution-ShareAlike license:
# http://creativecommons.org/licenses/by-sa/3.0.
import nox
nox.options.sessions = []
@nox.session()
def translation(session):
"""
Build the gettext .pot files.
"""
session.install("-r", "requirements.txt")
target_dir = "locales"
session.run(
"sphinx-build",
"-b",
"gettext", # build gettext-style message catalogs (.pot file)
"-d",
session.cache_dir / ".doctrees", # path to put the cache
"source/", # where the rst files are located
target_dir, # where to put the .pot file
)
@nox.session()
def build(session, autobuild=False):
"""
Make the website.
"""
session.install("-r", "requirements.txt")
if autobuild:
command = "sphinx-autobuild"
extra_args = "--host", "0.0.0.0"
else:
# NOTE: This branch adds options that are unsupported by autobuild
command = "sphinx-build"
extra_args = (
"--color", # colorize the output
"--keep-going", # don't interrupt the build on the first warning
)
session.run(
command,
*extra_args,
"-j",
"auto", # parallelize the build
"-b",
"html", # use HTML builder
"-d",
session.cache_dir / ".doctrees", # path to put the cache
"-n", # nitpicky warn about all missing references
"-W", # Treat warnings as errors.
*session.posargs,
"source", # where the rst files are located
"build", # where to put the html output
)
@nox.session()
def preview(session):
"""
Make and preview the website.
"""
session.install("sphinx-autobuild")
build(session, autobuild=True)
@nox.session()
def linkcheck(session):
"""
Check for broken links.
"""
session.install("-r", "requirements.txt")
session.run(
"sphinx-build",
"-b",
"linkcheck", # use linkcheck builder
"-d",
session.cache_dir / ".doctrees", # path to put the cache
"--color",
"-n",
"-W",
"--keep-going", # be strict
"source", # where the rst files are located
"build", # where to put the check output
)
@nox.session()
def checkqa(session):
"""
Format the guide using pre-commit.
"""
session.install("pre-commit")
session.run(
"pre-commit",
"run",
"--all-files",
"--show-diff-on-failure",
)