Merge pull request #7123 from tk0miya/7108_ConfigError_in_conf.py

Close #7108: Allow to show an error message from conf.py via ConfigError

2 files changed, 4 insertions, 0 deletions

diff --git a/CHANGES b/CHANGES
index 92dc4637e..83b1963e2 100644
--- a/CHANGES
+++ b/CHANGES
@@ -49,6 +49,7 @@ Features added
 * #3077: Implement the scoping for :rst:dir:`productionlist` as indicated
   in the documentation.
 * #1027: Support backslash line continuation in :rst:dir:`productionlist`.
+* #7108: config: Allow to show an error message from conf.py via ``ConfigError``
 
 Bugs fixed
 ----------
diff --git a/sphinx/config.py b/sphinx/config.py
index ca99fd5b7..87007c33d 100644
--- a/sphinx/config.py
+++ b/sphinx/config.py
@@ -324,6 +324,9 @@ def eval_config_file(filename: str, tags: Tags) -> Dict[str, Any]:
             msg = __("The configuration file (or one of the modules it imports) "
                      "called sys.exit()")
             raise ConfigError(msg)
+        except ConfigError:
+            # pass through ConfigError from conf.py as is.  It will be shown in console.
+            raise
         except Exception:
             msg = __("There is a programmable error in your configuration file:\n\n%s")
             raise ConfigError(msg % traceback.format_exc())