From c6671a67dd85a8a0a083d13a1533c5cc77b2ebe4 Mon Sep 17 00:00:00 2001 From: tushar912 Date: Thu, 8 Apr 2021 11:03:44 +0530 Subject: [PATCH] tools: Add tools/build-docs --clean option. Currently the tools/build-docs was slow because the clean option was rebulding everything. But this is only required if one wants the left sidebar to update. So now set the default to exclude clean and add clean option only if --clean is passed. Also a warning is displayed if clean option is not passed that the left sidebar won't update. Fixes #17961. --- tools/build-docs | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/tools/build-docs b/tools/build-docs index 5b8dca523e..0e50923e39 100755 --- a/tools/build-docs +++ b/tools/build-docs @@ -5,16 +5,30 @@ from lib import sanity_check sanity_check.check_venv(__file__) +import argparse import os import sys ZULIP_PATH = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) sys.path.append(ZULIP_PATH) -from scripts.lib.zulip_tools import run +from scripts.lib.zulip_tools import ENDC, WARNING, run def main() -> None: + parser = argparse.ArgumentParser() + parser.add_argument("-c", "--clean", action="store_true") + args = parser.parse_args() + path = os.path.join(ZULIP_PATH, "docs") + if not args.clean: + run(["make", "html", "-C", path]) + print( + WARNING + + "tools/build-docs --clean is necessary for the navigation/left sidebar to update." + + ENDC + ) + return + run(["make", "clean", "html", "-C", path])