fc4bbd8f07
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
34 lines
807 B
ReStructuredText
34 lines
807 B
ReStructuredText
Run sphinx to generate documentation
|
|
|
|
**Role Variables**
|
|
|
|
.. zuul:rolevar:: sphinx_source_dir
|
|
:default: doc/source
|
|
|
|
Directory relative to zuul_work_dir that contains the Sphinx sources.
|
|
|
|
.. zuul:rolevar:: sphinx_build_dir
|
|
:default: doc/build
|
|
|
|
Directory relative to zuul_work_dir where build output will be put.
|
|
|
|
.. zuul:rolevar:: sphinx_builders
|
|
:default: ['html']
|
|
|
|
Which sphinx builders to run.
|
|
|
|
.. zuul:rolevar:: sphinx_warning_is_error
|
|
|
|
Whether to treat sphinx build warnings as errors. Defaults to undefined
|
|
which means to attempt to find the setting in a setup.cfg file.
|
|
|
|
.. zuul:rolevar:: zuul_work_virtualenv
|
|
:default: ~/.venv
|
|
|
|
Virtualenv that sphinx is installed in.
|
|
|
|
.. zuul:rolevar:: zuul_work_dir
|
|
:default: {{ zuul.project.src_dir }}
|
|
|
|
Directory to operate in.
|