MCPcopy
hub / github.com/saltstack/salt / docs_man

Function docs_man

noxfile.py:1738–1757  ·  view source on GitHub ↗

Build Salt's Manpages Documentation

(session, compress, update, clean)

Source from the content-addressed store, hash-verified

1736@nox.parametrize("update", [False, True])
1737@nox.parametrize("compress", [False, True])
1738def docs_man(session, compress, update, clean):
1739 """
1740 Build Salt's Manpages Documentation
1741 """
1742 if _upgrade_pip_setuptools_and_wheel(session):
1743 requirements_file = os.path.join(
1744 "requirements", "static", "ci", _get_pydir(session), "docs.lock"
1745 )
1746 install_command = ["--progress-bar=off", "-r", requirements_file]
1747 session.install(*install_command, silent=PIP_INSTALL_SILENT)
1748 os.chdir("doc/")
1749 if clean:
1750 session.run("make", "clean", external=True)
1751 session.run("make", "man", "SPHINXOPTS=-W", external=True)
1752 if update:
1753 session.run("rm", "-rf", "man/", external=True)
1754 session.run("cp", "-Rp", "_build/man", "man/", external=True)
1755 if compress:
1756 session.run("tar", "-cJvf", "man-archive.tar.xz", "_build/man", external=True)
1757 os.chdir("..")
1758
1759
1760@nox.session(name="changelog", python="3")

Callers

nothing calls this directly

Calls 4

_get_pydirFunction · 0.85
installMethod · 0.45
runMethod · 0.45

Tested by

no test coverage detected