From 23e638231c3d33a64bf6629d22e5dcfe6d4e9e9b Mon Sep 17 00:00:00 2001 From: AA Turner <9087854+AA-Turner@users.noreply.github.com> Date: Fri, 7 May 2021 15:53:51 +0100 Subject: [PATCH] Build to directories by default --- Makefile | 2 +- build.py | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 140b644aa4f9..930ff31a04a4 100644 --- a/Makefile +++ b/Makefile @@ -70,4 +70,4 @@ fail_on_warning: $(SPHINX_BUILD) --fail-on-warning check_links: - $(SPHINX_BUILD) --builder linkcheck + $(SPHINX_BUILD) --check-links diff --git a/build.py b/build.py index 64e0e50983e0..bd615eb1493c 100644 --- a/build.py +++ b/build.py @@ -8,8 +8,8 @@ def create_parser(): parser = argparse.ArgumentParser(description="Build PEP documents") - # builders: - parser.add_argument("-b", "--builder", default="html", choices=("html", "dirhtml", "linkcheck")) + # alternative builders: + parser.add_argument("-l", "--check-links", action="store_true") # flags / options parser.add_argument("-f", "--fail-on-warning", action="store_true") @@ -30,6 +30,12 @@ def create_parser(): build_directory = root_directory / "build" # synchronise with deploy-gh-pages.yaml -> deploy step doctree_directory = build_directory / ".doctrees" + # builder configuration + sphinx_builder = "dirhtml" + if args.check_links: + sphinx_builder = "linkcheck" + + # other configuration config_overrides = {} if args.nitpicky: config_overrides["nitpicky"] = True @@ -39,7 +45,7 @@ def create_parser(): confdir=source_directory, outdir=build_directory, doctreedir=doctree_directory, - buildername=args.builder, + buildername=sphinx_builder, confoverrides=config_overrides, warningiserror=args.fail_on_warning, parallel=args.jobs,