OpenStack Dashboard (Horizon)

lots of docs warning showing up

Bug #1486222 reported by David Lyle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Medium
Akihiro Motoki

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.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/214318

Changed in horizon:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/214379

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/214318
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=6fbb70ebf20aec04b5a21640d43f21eab8493119
Submitter: Jenkins
Branch: master

commit 6fbb70ebf20aec04b5a21640d43f21eab8493119
Author: David Lyle <email address hidden>
Date: Tue Aug 18 13:40:02 2015 -0600

    Fixing .rst file issues

    Correcting errors in rst file formatting.

    Partial-Bug: #1486222
    Change-Id: Id0a703d42609165a17ca84dade94b2c04894e208

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/214379
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=efafd2ba9693aa27bf62561f39d98cc2361ce280
Submitter: Jenkins
Branch: master

commit efafd2ba9693aa27bf62561f39d98cc2361ce280
Author: David Lyle <email address hidden>
Date: Tue Aug 18 17:13:29 2015 -0600

    Fixing docstring formatting errors and warnings

    Correcting numerous errors and warnings for doc generation.

    Partial-Bug: #1486222
    Change-Id: I6d6b20a433aa9965a1bafbd098e64b19886e5fca

Revision history for this message
Timur Sufiev (tsufiev-x) wrote :

Hmm, seems like the same issue as https://bugs.launchpad.net/horizon/+bug/1411719 to me.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/374053

Changed in horizon:
assignee: David Lyle (david-lyle) → Akihiro Motoki (amotoki)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/374054

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/374055

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/374056

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/374053
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=ee04fca67ed9932bf47ceef73b5f31174a68173a
Submitter: Jenkins
Branch: master

commit ee04fca67ed9932bf47ceef73b5f31174a68173a
Author: Akihiro Motoki <email address hidden>
Date: Tue Sep 20 21:28:52 2016 +0000

    Fix warnings in devref document

    WARNING: invalid signature for autoclass (u'UpdateAction **DEPRECATED**')
    WARNING: Literal block expected; none found.
    WARNING: Duplicate explicit target name: "here".
    WARNING: Definition list ends without a blank line; unexpected unindent.

    Partial-Bug: #1411719
    Partial-Bug: #1486222
    Change-Id: I1996269d2b5db15096796bda25b35c6560f683d2

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/374054
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=35d2becdd6ae616add96bd03a67e6a9c294da124
Submitter: Jenkins
Branch: master

commit 35d2becdd6ae616add96bd03a67e6a9c294da124
Author: Akihiro Motoki <email address hidden>
Date: Wed Sep 21 09:04:53 2016 +0900

    Fix docstring warnings

    Partial-Bug: #1411719
    Partial-Bug: #1486222

    Change-Id: I2d649295e7425ab73f09f3a5d91076350bf7ed7a

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/374055
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=215ccba9ec25d8033f959247afbb3af6a0acf3b5
Submitter: Jenkins
Branch: master

commit 215ccba9ec25d8033f959247afbb3af6a0acf3b5
Author: Akihiro Motoki <email address hidden>
Date: Tue Sep 20 21:17:20 2016 +0000

    doc: Do not generate no source code reference

    horizon devref has both explicit autodoc directives and
    automatically generated source references.
    This causes a lot of 'WARNING: duplicate object description'.

    I think that we don't need source code references for most modules
    and it is better to have explicit API references of modules
    for which we need references. Thus this commit removes the logic
    to generate source references.

    This contributes a lot to reduce the number of sphinx warnings.
    Also reduces the required time of documentation build :-)

    Partial-Bug: #1411719
    Partial-Bug: #1486222
    Change-Id: Iba2bf3723cad159f4cfd1fff47e8114d9867e040

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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 <email address hidden>
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
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/horizon 11.0.0.0b1

This issue was fixed in the openstack/horizon 11.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.