zuul/zuul-jobs
Code Issues Proposed changes

Support autodoc_tree_index_modules in sphinx role

Browse Source 
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
This commit is contained in:
Clark Boylan 2017-12-18 19:24:30 -08:00
parent 1e1c54e23b
commit bd579c2b5b
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
roles/sphinx/library/sphinx_check_warning_is_error.py
View File

@ -72,6 +72,7 @@ def main():
# TODO(mordred) Remove autodoc_index_modules logic when we get OpenStack
# projects off of the pbr autoindex
autodoc_index_modules = False
autodoc_tree_index_modules = False
if not os.path.exists(os.path.join(project_dir, 'setup.cfg')):
module.exit_json(
@ -95,6 +96,12 @@ def main():
warning_is_error = c.getboolean('build_sphinx', 'warning-is-error')
if c.has_section('pbr') and c.has_option('pbr', 'autodoc_index_modules'):
autodoc_index_modules = c.getboolean('pbr', 'autodoc_index_modules')
if (c.has_section('pbr') and
c.has_option('pbr', 'autodoc_tree_index_modules')):
autodoc_tree_index_modules = c.getboolean('pbr',
'autodoc_tree_index_modules')
# Set it if either options is set and defer to pbr to figure it out.
autodoc_index_modules = autodoc_index_modules or autodoc_tree_index_modules
module.exit_json(
changed=False,
warning_is_error=warning_is_error,