zuul
/
zuul-jobs
Code Issues Proposed changes
zuul-jobs/roles/sphinx
History
Andreas Jaeger 7ee3db4d1b Fix non-standard docs build 
sphinx_warning_is_error and sphinx-pbr_autodoc are only useful for the
default documents living in doc/ - but not for api-ref, api-guide, etc.

Check for standard builds and do not run the "python setup.py
build_sphinx" or whereto for non-standard paths.

Change-Id: Ia8edd8a6ebc24f67a52d77c21b0cfa467e45a7ce
 		2017-12-26 13:29:12 +01:00
..
defaults Add general sphinx and reno jobs and role 2017-11-20 17:59:28 -06:00
library Support autodoc_tree_index_modules in sphinx role 2017-12-18 19:51:02 -08:00
tasks Fix non-standard docs build 2017-12-26 13:29:12 +01:00
README.rst Add support for warning-is-error to sphinx role 2017-11-20 18:00:26 -06:00

README.rst

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.