Merge pull request #26 from python-project-templates/tkp/exit

Fail process if issue during build

Author: timkpaine

pyproject.toml

@@ -123,6 +123,9 @@ testpaths = "yardang/tests"
 [tool.ruff]
 line-length = 150
 
+[tool.ruff.lint]
+extend-select = ["I"]
+
 [tool.ruff.lint.isort]
 combine-as-imports = true
 default-section = "third-party"

yardang/build.py

@@ -1,9 +1,11 @@
 import os.path
 from contextlib import contextmanager
-from jinja2 import Environment, FileSystemLoader
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from typing import List, Optional
+
+from jinja2 import Environment, FileSystemLoader
+
 from .utils import get_config
 
 __all__ = ("generate_docs_configuration",)

yardang/cli.py

@@ -1,7 +1,8 @@
-from sys import executable, stderr, stdout
 from subprocess import Popen
+from sys import executable, stderr, stdout
 from time import sleep
-from typer import Typer
+
+from typer import Exit, Typer
 
 from .build import generate_docs_configuration
 
@@ -26,6 +27,8 @@ def build(quiet: bool = False, debug: bool = False):
             process = Popen(build_cmd, stderr=stderr, stdout=stdout)
         while process.poll() is None:
             sleep(0.1)
+        if process.returncode != 0:
+            raise Exit(process.returncode)
 
 
 def debug():

yardang/conf.py.j2

@@ -50,9 +50,7 @@ if use_autoapi in (True, None):
 else:
     # NOTE: bug in autoapi that requires
     # viewcode to come after
-    extensions.append([
-        "sphinx.ext.viewcode",
-    ])
+    extensions.append("sphinx.ext.viewcode")
 
 
 os.environ["SPHINX_BUILDING"] = "1"

yardang/utils.py

@@ -1,7 +1,7 @@
 import os
-import toml
 from pathlib import Path
 
+import toml
 
 __all__ = ("get_config",)