Fail the Sphinx render workflow on warnings from Docutils (#2288)

python · Jan 28, 2022 · 5c62d9d · 5c62d9d
1 parent 7952141
commit 5c62d9d
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/pep_sphinx_extensions/__init__.py b/pep_sphinx_extensions/__init__.py
@@ -36,6 +36,7 @@ def setup(app: Sphinx) -> dict[str, bool]:
     """Initialize Sphinx extension."""
 
     environment.default_settings["pep_url"] = "pep-{:0>4}.html"
+    environment.default_settings["halt_level"] = 2  # Fail on Docutils warning
 
     # Register plugin logic
     app.add_builder(pep_html_builder.FileBuilder, override=True)