Reviewed: https://review.openstack.org/374056
Committed:
https://git.openstack.org/cgit/openstack/horizon/commit/?id=f880f6c723cabf3eb2bf9053d4560e6c1dc6844b
Submitter: Jenkins
Branch: master
commit f880f6c723cabf3eb2bf9053d4560e6c1dc6844b
Author: Akihiro Motoki <amot...@gmail.com>
Date: Wed Sep 21 07:08:28 2016 +0900
Turn on docs warning check in document generation
Use -W (turn warnings into errors) option of sphinx-build
in the commandline of 'docs' tox target so that developer
can easily check sphinx warning.
Also runs the same documentation check in 'pep8' tox target
to detect sphinx warning in the gate.
The current 'docs' job in the gate does not use 'tox -edocs'
intentionally and calls build_sphinx via 'tox -evenv' [1],
so sphinx warnings are not detected in the 'docs' job.
Note that we no longer generate the whole code reference so this
change does not increase the time of 'tox -epep8' much,
while we can prevent new sphinx warnings.
[1]
https://github.com/openstack-infra/project-config/blob/6b50d7e3a69c49d1e035c6d026d8e3910e62a981/jenkins/scripts/run-docs.sh#L16-L19
Closes-Bug: #1411719
Closes-Bug: #1486222
Change-Id: Idc6e8a1c5762eba113b2d110d5fa223ab7406be3
** Changed in: horizon
Status: In Progress => Fix Released
--
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Dashboard (Horizon).
https://bugs.launchpad.net/bugs/1486222
Title:
lots of docs warning showing up
Status in OpenStack Dashboard (Horizon):
Fix Released
Bug description:
There are a high number of warnings in the doc generation process.
These should all be fixed and have errors block merging.
/home/david-lyle/horizon_test/doc/source/contributing.rst:299: WARNING:
Enumerated list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:33: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:34: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:37: SEVERE: Unexpected section title or
transition.
....
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:38: SEVERE: Unexpected section title or
transition.
....
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:42: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:48: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/david-lyle/horizon_test/doc/source/ref/run_tests.rst:190: WARNING:
Title underline too short.
ESLint
----
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.Column:124: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.Column:125: WARNING: Block quote ends without a blank line;
unexpected unindent.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.Column:127: WARNING: Definition list ends without a blank line;
unexpected unindent.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.Column:128: SEVERE: Unexpected section title.
...
...
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:8: WARNING: duplicate object description of
horizon.Dashboard.name, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of th#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:14: WARNING: duplicate object description of
horizon.Dashboard.slug, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of t#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:19: WARNING: duplicate object description of
horizon.Dashboard.panels, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:51: WARNING: duplicate object description of
horizon.Dashboard.default_panel, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:58: WARNING: duplicate object description of
horizon.Dashboard.permissions, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for o#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:65: WARNING: duplicate object description of
horizon.Dashboard.urls, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of t#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:70: WARNING: duplicate object description of
horizon.Dashboard.nav, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of th#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Dashboard:78: WARNING: duplicate object description of
horizon.Dashboard.public, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:7: WARNING: duplicate object description of horizon.Panel.name,
other instance in /home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use
:noindex: for one of them
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:13: WARNING: duplicate object description of horizon.Panel.slug,
other instance in /home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use
:noindex: for one of them
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:18: WARNING: duplicate object description of
horizon.Panel.permissions, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of th#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:25: WARNING: duplicate object description of horizon.Panel.urls,
other instance in /home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use
:noindex: for one of them
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:32: WARNING: duplicate object description of horizon.Panel.nav,
other instance in /home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use
:noindex: for one of them
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:40: WARNING: duplicate object description of
horizon.Panel.index_url_name, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.Panel:46: WARNING: duplicate object description of
horizon.Panel.can_register, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of t#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.PanelGroup:6: WARNING: duplicate object description of
horizon.PanelGroup.slug, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of #
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.PanelGroup:10: WARNING: duplicate object description of
horizon.PanelGroup.name, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
of#
/home/david-lyle/horizon_test/horizon/__init__.py:docstring of
horizon.PanelGroup:15: WARNING: duplicate object description of
horizon.PanelGroup.panels, other instance in
/home/david-lyle/horizon_test/doc/source/ref/horizon.rst, use :noindex: for one
#
/home/david-lyle/horizon_test/doc/source/sourcecode/horizon/horizon.forms.rst:4:
WARNING: missing attribute mentioned in :members: or __all__: module
horizon.forms, attribute SelectWidgetValidationError
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.IPField:12: WARNING: duplicate object description of
horizon.forms.fields.IPField.version, other instance in
/home/david-lyle/horizon_test/doc/source/ref/forms.rst,#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.IPField:19: WARNING: duplicate object description of
horizon.forms.fields.IPField.mask, other instance in
/home/david-lyle/horizon_test/doc/source/ref/forms.rst, us#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.IPField:24: WARNING: duplicate object description of
horizon.forms.fields.IPField.mask_range_from, other instance in
/home/david-lyle/horizon_test/doc/source/ref/fo#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:6: WARNING: duplicate object description of
horizon.forms.fields.SelectWidget.data_attrs, other instance in
/home/david-lyle/horizon_test/doc/source/re#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:14: WARNING: duplicate object description of
horizon.forms.fields.SelectWidget.transform, other instance in
/home/david-lyle/horizon_test/doc/source/re#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:19: WARNING: duplicate object description of
horizon.forms.fields.SelectWidget.transform_html_attrs, other instance in
/home/david-lyle/horizon_test/do#
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:33: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:34: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:37: SEVERE: Unexpected section title or
transition.
....
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:38: SEVERE: Unexpected section title or
transition.
....
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:42: WARNING: Block quote ends without a blank
line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/forms/fields.py:docstring of
horizon.forms.fields.SelectWidget:48: WARNING: Definition list ends without a
blank line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.base.Column:124: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.base.Column:125: WARNING: Block quote ends without a blank line;
unexpected unindent.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.base.Column:127: WARNING: Definition list ends without a blank
line; unexpected unindent.
/home/david-lyle/horizon_test/horizon/tables/base.py:docstring of
horizon.tables.base.Column:128: SEVERE: Unexpected section title.
...
...
/home/david-lyle/horizon_test/horizon/utils/file_discovery.py:docstring of
horizon.utils.file_discovery.sort_js_files:6: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/utils/file_discovery.py:docstring of
horizon.utils.file_discovery.sort_js_files:8: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/horizon/utils/file_discovery.py:docstring of
horizon.utils.file_discovery.sort_js_files:10: WARNING: Block quote ends
without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/api/glance.py:docstring of
openstack_dashboard.api.glance.image_create:5: ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/openstack_dashboard/api/glance.py:docstring of
openstack_dashboard.api.glance.image_create:6: WARNING: Block quote ends
without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/api/glance.py:docstring of
openstack_dashboard.api.glance.metadefs_namespace_list:4: ERROR: Unexpected
indentation.
/home/david-lyle/horizon_test/openstack_dashboard/api/glance.py:docstring of
openstack_dashboard.api.glance.metadefs_namespace_list:9: WARNING: Block quote
ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/api/network_base.py:docstring
of openstack_dashboard.api.network_base.SecurityGroupManager:24: WARNING:
Bullet list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/api/rest/neutron.py:docstring
of openstack_dashboard.api.rest.neutron.Networks.post:3: ERROR: Unexpected
indentation.
/home/david-lyle/horizon_test/openstack_dashboard/api/rest/neutron.py:docstring
of openstack_dashboard.api.rest.neutron.Networks.post:4: WARNING: Block quote
ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/dashboards/project/images/utils.py:docstring
of openstack_dashboard.dashboards.project.images.utils.image_field_data:8:
WARNING: Field list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/dashboards/project/instances/utils.py:docstring
of openstack_dashboard.dashboards.project.instances.utils.flavor_field_data:8:
WARNING: Field list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/dashboards/project/instances/utils.py:docstring
of
openstack_dashboard.dashboards.project.instances.utils.keypair_field_data:8:
WARNING: Field list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/openstack_dashboard/dashboards/project/instances/utils.py:docstring
of
openstack_dashboard.dashboards.project.instances.utils.network_field_data:8:
WARNING: Field list ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/doc/source/topics/angularjs.rst:149: ERROR:
Unexpected indentation.
/home/david-lyle/horizon_test/doc/source/topics/angularjs.rst:150: WARNING:
Literal block ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/doc/source/topics/javascript_testing.rst:68:
ERROR: Unexpected indentation.
/home/david-lyle/horizon_test/doc/source/topics/javascript_testing.rst:69:
WARNING: Literal block ends without a blank line; unexpected unindent.
/home/david-lyle/horizon_test/doc/source/topics/settings.rst:517: ERROR:
Unexpected indentation.
/home/david-lyle/horizon_test/doc/source/topics/settings.rst:520: WARNING:
Block quote ends without a blank line; unexpected unindent.
To manage notifications about this bug go to:
https://bugs.launchpad.net/horizon/+bug/1486222/+subscriptions
--
Mailing list: https://launchpad.net/~yahoo-eng-team
Post to : yahoo-eng-team@lists.launchpad.net
Unsubscribe : https://launchpad.net/~yahoo-eng-team
More help : https://help.launchpad.net/ListHelp
