raising_config_errors

documenteer.conf.raising_config_errors()

Make a configuration failure inside the block raise ConfigError instead of ending the process.

This is for a Sphinx build run inside a process that has other work to do — Documenteer’s own in-process read behind documenteer technote lint and documenteer technote sync-cff, and, downstream, a project that drives a build from a pytest fixture, a notebook, or a script of its own. Such a build’s configuration failure is one result among several the caller is collecting, so it has to come back as an exception the caller can catch and report in its own voice rather than as the process exit a sphinx-build run wants.

It is re-exported as documenteer.conf.raising_config_errors, which is the name to import: a build of a deliberately invalid configuration file that is not wrapped in this block ends the interpreter with status 2 and no traceback, taking the test session or notebook kernel with it.

Return type:

Iterator[None]