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

Function docs_html

noxfile.py:1715–1731  ·  view source on GitHub ↗

Build Salt's HTML Documentation

(session, compress, clean)

Source from the content-addressed store, hash-verified

1713@nox.parametrize("clean", [False, True])
1714@nox.parametrize("compress", [False, True])
1715def docs_html(session, compress, clean):
1716 """
1717 Build Salt's HTML Documentation
1718 """
1719 if _upgrade_pip_setuptools_and_wheel(session):
1720 requirements_file = os.path.join(
1721 "requirements", "static", "ci", _get_pydir(session), "docs.lock"
1722 )
1723 install_command = ["--progress-bar=off", "-r", requirements_file]
1724 session.install(*install_command, silent=PIP_INSTALL_SILENT)
1725 os.chdir("doc/")
1726 if clean:
1727 session.run("make", "clean", external=True)
1728 session.run("make", "html", "SPHINXOPTS=-W", external=True)
1729 if compress:
1730 session.run("tar", "-cJvf", "html-archive.tar.xz", "_build/html", external=True)
1731 os.chdir("..")
1732
1733
1734@nox.session(name="docs-man", 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