Build to directories by default

python · May 7, 2021 · 23e6382 · 23e6382
1 parent e5928b1
commit 23e6382
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git 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
@@ -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,