RestrictionsΒΆ

Restriction: Warning to Error RE_SPHINX_WARNINGS

Always use the sphinx-build option -W to transform all warnings into errors, because only errors stop the build and set an exit code > 0.

Restriction: Clean full build RE_SPHINX_CLEAN
style: orange_bar

Always use a clean and full sphinx-build. An incremental build is not allowed, as not all files get updated by Sphinx.

So before the sphinx-build command gets executed, the related build folder shall be deleted. Then sphinx-build shall be built with the options -a and -E to force Sphinx to read and write really all files.