zuul-jobs/roles/sphinx
Clark Boylan bd579c2b5b Support autodoc_tree_index_modules in sphinx role
PBR supports two flags for autodoc in sphinx, autodoc_index_modules and
autodoc_tree_index_modules. We were only supporting
autodoc_index_modules but some projects like keystone use
autodoc_tree_index_modules. Address this by setting the autodoc flag to
true if either is set to true and defer to pbr to figure out what it
means.

Change-Id: If856e4b838d013781c0690b4ac1c2b37900d0fdd
2017-12-18 19:51:02 -08: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 Handle projects still using pbr autodoc_index_modules 2017-12-18 21:31:56 +01:00
README.rst Add support for warning-is-error to sphinx role 2017-11-20 18:00:26 -06:00

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.