openstack
/
keystone
Code Issues Proposed changes

Exclude 'keystone_tempest_plugin' in doc build 

When building keystone docs, autodoc goes through all of
the project in order to auto-generate api docs. When going
through 'keystone_tempest_plugin', there are currently 6
warnings that are emitted due to issues with duplicate
option errors. These errors seem to be related to duplicate
named options between tempest and oslo.config, rather than
keystone.

Due to these warnings, there are already multiple issues with
the api page [1] not rendering everything.

This change adds 'keystone_tempest_plugin' to the exclusion list
for autodoc and as a result, removes the 6 warnings from doc building
since 'keystone_tempest_plugin' will no longer be auto-generated
with incomplete info.

[1] http://docs.openstack.org/developer/keystone/api/keystone_tempest_plugin.html

Change-Id: Icb5c518b2f1409e2e9580b14ba1ae0e44995a73c
Co-Authored-By: Tin Lam <tinlam@gmail.com>
Partial-Bug: #1602422
This commit is contained in:
Gage Hugo 2017-01-13 14:26:27 -06:00
parent 905e1ad2e1
commit 0d2f249f59
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
setup.cfg
View File

@ -72,6 +72,11 @@ msgid_bugs_address = https://bugs.launchpad.net/keystone
# http://lists.openstack.org/pipermail/openstack-dev/2016-June/097849.html
#warnerrors = True
autodoc_tree_index_modules = True
# NOTE(gagehugo): building docs with autodoc_tree_index_modules set to True
# causes warnings when creating api docs with keystone_tempest_plugin and
# these issues seem to be related to tempest/oslo_config rather than
# keystone.
autodoc_tree_excludes = keystone_tempest_plugin
[entry_points]
console_scripts =