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 2

Fix sphinx variable typo and pass -j auto to parallelize the builds.

Browse source 
Signed-off-by: Pedro Algarvio <palgarvio@vmware.com>
This commit is contained in:
Pedro Algarvio 2023-02-16 05:21:41 +00:00 • committed by Pedro Algarvio
parent 46ace5e44a
commit 14300ef64c
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
tools/docs.py
View file

@ -45,7 +45,7 @@ docs = command_group(
def man(ctx: Context, no_clean: bool = False):
if no_clean is False:
ctx.run("make", "clean", cwd="doc/", check=True)
ctx.run("make", "man", "SHPINXOPTS=-W", cwd="doc/", check=True)
ctx.run("make", "man", "SPHINXOPTS=-W -j auto", cwd="doc/", check=True)
for root, dirs, files in os.walk("doc/_build/man"):
for file in files:
shutil.copy(os.path.join(root, file), os.path.join("doc/man", file))
@ -65,7 +65,7 @@ def man(ctx: Context, no_clean: bool = False):
def html(ctx: Context, no_clean: bool = False, archive: pathlib.Path = None):
if no_clean is False:
ctx.run("make", "clean", cwd="doc/", check=True)
ctx.run("make", "html", "SHPINXOPTS=-W", cwd="doc/", check=True)
ctx.run("make", "html", "SPHINXOPTS=-W -j auto", cwd="doc/", check=True)
if archive is not None:
ctx.info(f"Compressing the generated documentation to '{archive}'...")
ctx.run("tar", "caf", str(archive.resolve()), ".", cwd="doc/_build/html")
@ -82,7 +82,7 @@ def html(ctx: Context, no_clean: bool = False, archive: pathlib.Path = None):
def epub(ctx: Context, no_clean: bool = False):
if no_clean is False:
ctx.run("make", "clean", cwd="doc/", check=True)
ctx.run("make", "epub", "SHPINXOPTS=-W", cwd="doc/", check=True)
ctx.run("make", "epub", "SPHINXOPTS=-W -j auto", cwd="doc/", check=True)
@docs.command(
@ -99,4 +99,4 @@ def pdf(ctx: Context, no_clean: bool = False):
ctx.exit(1)
if no_clean is False:
ctx.run("make", "clean", cwd="doc/", check=True)
ctx.run("make", "pdf", "SHPINXOPTS=-W", cwd="doc/", check=True)
ctx.run("make", "pdf", "SPHINXOPTS=-W -j auto", cwd="doc/", check=True)