saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

add clean kwarg to doc builds

Browse source
This commit is contained in:
ch3ll 2020-08-07 16:16:08 -04:00 • committed by Daniel Wozniak
parent 5539fc0f52
commit 035239de82
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
noxfile.py
View file

@ -1143,9 +1143,10 @@ def lint_tests_pre_commit(session):
@nox.session(python="3")
@nox.parametrize("clean", [False, True])
@nox.parametrize("update", [False, True])
@nox.parametrize("compress", [False, True])
def docs(session, compress, update):
def docs(session, compress, update, clean):
"""
Build Salt's Documentation
"""
@ -1156,13 +1157,15 @@ def docs(session, compress, update):
"docs-man-{}".format(session.python),
compress=compress,
update=update,
clean=clean,
)
)
@nox.session(name="docs-html", python="3")
@nox.parametrize("clean", [False, True])
@nox.parametrize("compress", [False, True])
def docs_html(session, compress):
def docs_html(session, compress, clean):
"""
Build Salt's HTML Documentation
"""
@ -1173,7 +1176,8 @@ def docs_html(session, compress):
install_command = ["--progress-bar=off", "-r", requirements_file]
session.install(*install_command, silent=PIP_INSTALL_SILENT)
os.chdir("doc/")
session.run("make", "clean", external=True)
if clean:
session.run("make", "clean", external=True)
session.run("make", "html", "SPHINXOPTS=-W", external=True)
if compress:
session.run("tar", "-cJvf", "html-archive.tar.xz", "_build/html", external=True)
@ -1181,9 +1185,10 @@ def docs_html(session, compress):
@nox.session(name="docs-man", python="3")
@nox.parametrize("clean", [False, True])
@nox.parametrize("update", [False, True])
@nox.parametrize("compress", [False, True])
def docs_man(session, compress, update):
def docs_man(session, compress, update, clean):
"""
Build Salt's Manpages Documentation
"""
@ -1194,7 +1199,8 @@ def docs_man(session, compress, update):
install_command = ["--progress-bar=off", "-r", requirements_file]
session.install(*install_command, silent=PIP_INSTALL_SILENT)
os.chdir("doc/")
session.run("make", "clean", external=True)
if clean:
session.run("make", "clean", external=True)
session.run("make", "man", "SPHINXOPTS=-W", external=True)
if update:
session.run("rm", "-rf", "man/", external=True)