zuul-jobs/roles/sphinx/README.rst
Monty Taylor fc4bbd8f07
Add support for warning-is-error to sphinx role
Sphinx currently does not have a way to set warning-is-error in a config
file for builds that do not use python setup.py build_sphinx. It's
perfectly reasonable to use Sphinx for non-python languages, but putting
a setup.cfg into those projects is a bit weird. While we wait on getting
a config setting upstream, read the value out of setup.cfg ourselves if
it exists. This will let existing python projects with the setting work
as we expect, but will also let us just set a zuul variable for
non-python projects if we decide to not just put a setup.cfg in them.

Change-Id: Ie65dcb42c48e6a962f6715f7483ef3758caf2965
2017-11-20 18:00:26 -06:00

807 B

Run sphinx to generate documentation

Role Variables

Whether to treat sphinx build warnings as errors. Defaults to undefined which means to attempt to find the setting in a setup.cfg file.