Warnings and Errors in Document generation

[Davanum Srinivas (DIMS)]

Just pick any recent docs build and you will see a ton of issues:

Example from:
http://logs.openstack.org/46/111146/1/check/gate-nova-docs/4f3e8c4/console.html

2014-08-01 03:40:18.805 | /home/jenkins/workspace/gate-nova-docs/nova/api/openstack/compute/contrib/hosts.py:docstring of nova.api.openstack.compute.contrib.hosts.HostController.index:3: ERROR: Unexpected indentation.
2014-08-01 03:40:18.806 | /home/jenkins/workspace/gate-nova-docs/nova/api/openstack/compute/contrib/hosts.py:docstring of nova.api.openstack.compute.contrib.hosts.HostController.index:5: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.806 | /home/jenkins/workspace/gate-nova-docs/nova/api/openstack/compute/plugins/v3/hosts.py:docstring of nova.api.openstack.compute.plugins.v3.hosts.HostController.index:6: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.806 | /home/jenkins/workspace/gate-nova-docs/nova/compute/resource_tracker.py:docstring of nova.compute.resource_tracker.ResourceTracker.resize_claim:7: ERROR: Unexpected indentation.
2014-08-01 03:40:18.807 | /home/jenkins/workspace/gate-nova-docs/nova/compute/resource_tracker.py:docstring of nova.compute.resource_tracker.ResourceTracker.resize_claim:8: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.847 | /home/jenkins/workspace/gate-nova-docs/nova/db/sqlalchemy/api.py:docstring of nova.db.sqlalchemy.api.instance_get_all_by_filters:23: WARNING: Definition list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.847 | /home/jenkins/workspace/gate-nova-docs/nova/db/sqlalchemy/api.py:docstring of nova.db.sqlalchemy.api.instance_get_all_by_filters:24: WARNING: Definition list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.847 | /home/jenkins/workspace/gate-nova-docs/nova/db/sqlalchemy/api.py:docstring of nova.db.sqlalchemy.api.instance_get_all_by_filters:31: ERROR: Unexpected indentation.
2014-08-01 03:40:18.848 | /home/jenkins/workspace/gate-nova-docs/nova/db/sqlalchemy/utils.py:docstring of nova.db.sqlalchemy.utils.create_shadow_table:6: ERROR: Unexpected indentation.
2014-08-01 03:40:18.848 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:15: WARNING: Inline emphasis start-string without end-string.
2014-08-01 03:40:18.849 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:15: WARNING: Inline strong start-string without end-string.
2014-08-01 03:40:18.849 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:18: WARNING: Inline emphasis start-string without end-string.
2014-08-01 03:40:18.849 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:18: WARNING: Inline strong start-string without end-string.
2014-08-01 03:40:18.850 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:23: WARNING: Inline emphasis start-string without end-string.
2014-08-01 03:40:18.850 | /home/jenkins/workspace/gate-nova-docs/nova/hooks.py:docstring of nova.hooks:23: WARNING: Inline strong start-string without end-string.
2014-08-01 03:40:18.850 | <autodoc>:0: WARNING: Inline emphasis start-string without end-string.
2014-08-01 03:40:18.851 | <autodoc>:0: WARNING: Inline strong start-string without end-string.
2014-08-01 03:40:18.851 | /home/jenkins/workspace/gate-nova-docs/nova/image/api.py:docstring of nova.image.api.API.get_all:8: WARNING: Inline strong start-string without end-string.
2014-08-01 03:40:18.852 | /home/jenkins/workspace/gate-nova-docs/nova/keymgr/key_mgr.py:docstring of nova.keymgr.key_mgr.KeyManager.copy_key:9: WARNING: Definition list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.852 | /home/jenkins/workspace/gate-nova-docs/nova/notifications.py:docstring of nova.notifications.info_from_instance:6: WARNING: Field list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.852 | /home/jenkins/workspace/gate-nova-docs/nova/objects/base.py:docstring of nova.objects.base.NovaObject.obj_make_compatible:10: ERROR: Unexpected indentation.
2014-08-01 03:40:18.853 | /home/jenkins/workspace/gate-nova-docs/nova/objects/base.py:docstring of nova.objects.base.NovaObject.obj_make_compatible:11: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.853 | /home/jenkins/workspace/gate-nova-docs/nova/objects/instance.py:docstring of nova.objects.instance.Instance.save:9: ERROR: Unexpected indentation.
2014-08-01 03:40:18.854 | /home/jenkins/workspace/gate-nova-docs/nova/objects/instance.py:docstring of nova.objects.instance.Instance.save:10: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.854 | /home/jenkins/workspace/gate-nova-docs/nova/objects/instance.py:docstring of nova.objects.instance.InstanceList.get_active_by_window_joined:9: WARNING: Field list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.854 | /home/jenkins/workspace/gate-nova-docs/nova/objects/pci_device.py:docstring of nova.objects.pci_device.PciDevice:31: ERROR: Unexpected indentation.
2014-08-01 03:40:18.887 | /home/jenkins/workspace/gate-nova-docs/nova/objects/pci_device.py:docstring of nova.objects.pci_device.PciDevice:33: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.887 | /home/jenkins/workspace/gate-nova-docs/nova/openstack/common/network_utils.py:docstring of nova.openstack.common.network_utils.set_tcp_keepalive:6: ERROR: Unexpected indentation.
2014-08-01 03:40:18.888 | /home/jenkins/workspace/gate-nova-docs/nova/openstack/common/report/report.py:docstring of nova.openstack.common.report.report.ReportSection:16: ERROR: Unexpected indentation.
2014-08-01 03:40:18.888 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_manager.py:docstring of nova.pci.pci_manager.PciDevTracker.get_free_devices_for_requests:5: ERROR: Unexpected indentation.
2014-08-01 03:40:18.889 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request:3: ERROR: Unexpected indentation.
2014-08-01 03:40:18.889 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request:11: ERROR: Unexpected indentation.
2014-08-01 03:40:18.889 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request:16: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.890 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request.get_pci_requests_from_flavor:17: ERROR: Unexpected indentation.
2014-08-01 03:40:18.891 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request.get_pci_requests_from_flavor:25: ERROR: Unexpected indentation.
2014-08-01 03:40:18.891 | /home/jenkins/workspace/gate-nova-docs/nova/pci/pci_request.py:docstring of nova.pci.pci_request.get_pci_requests_from_flavor:27: WARNING: Definition list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.892 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/isolated_hosts_filter.py:docstring of nova.scheduler.filters.isolated_hosts_filter.IsolatedHostsFilter.host_passes:3: ERROR: Unexpected indentation.
2014-08-01 03:40:18.892 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/isolated_hosts_filter.py:docstring of nova.scheduler.filters.isolated_hosts_filter.IsolatedHostsFilter.host_passes:4: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.892 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/isolated_hosts_filter.py:docstring of nova.scheduler.filters.isolated_hosts_filter.IsolatedHostsFilter.host_passes:10: ERROR: Unexpected indentation.
2014-08-01 03:40:18.893 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/isolated_hosts_filter.py:docstring of nova.scheduler.filters.isolated_hosts_filter.IsolatedHostsFilter.host_passes:11: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.893 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/pci_passthrough_filter.py:docstring of nova.scheduler.filters.pci_passthrough_filter.PciPassthroughFilter:9: ERROR: Unexpected indentation.
2014-08-01 03:40:18.893 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/pci_passthrough_filter.py:docstring of nova.scheduler.filters.pci_passthrough_filter.PciPassthroughFilter:10: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.894 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.894 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.894 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.895 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.927 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:3: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.928 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:10: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.930 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:10: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.933 | /home/jenkins/workspace/gate-nova-docs/nova/scheduler/filters/trusted_filter.py:docstring of nova.scheduler.filters.trusted_filter:20: WARNING: Inline interpreted text or phrase reference start-string without end-string.
2014-08-01 03:40:18.933 | /home/jenkins/workspace/gate-nova-docs/nova/tests/api/openstack/compute/plugins/v3/test_servers.py:docstring of nova.tests.api.openstack.compute.plugins.v3.test_servers.ServersAllExtensionsTestCase:11: ERROR: Unexpected indentation.
2014-08-01 03:40:18.934 | /home/jenkins/workspace/gate-nova-docs/nova/tests/api/openstack/compute/plugins/v3/test_servers.py:docstring of nova.tests.api.openstack.compute.plugins.v3.test_servers.ServersAllExtensionsTestCase:13: ERROR: Unexpected indentation.
2014-08-01 03:40:18.934 | /home/jenkins/workspace/gate-nova-docs/nova/tests/api/openstack/compute/test_servers.py:docstring of nova.tests.api.openstack.compute.test_servers.ServersAllExtensionsTestCase:11: ERROR: Unexpected indentation.
2014-08-01 03:40:18.935 | /home/jenkins/workspace/gate-nova-docs/nova/tests/api/openstack/compute/test_servers.py:docstring of nova.tests.api.openstack.compute.test_servers.ServersAllExtensionsTestCase:13: WARNING: Definition list ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.936 | /home/jenkins/workspace/gate-nova-docs/nova/tests/compute/test_resource_tracker.py:docstring of nova.tests.compute.test_resource_tracker.NoInstanceTypesInSysMetadata:3: ERROR: Unexpected indentation.
2014-08-01 03:40:18.937 | /home/jenkins/workspace/gate-nova-docs/nova/tests/compute/test_resource_tracker.py:docstring of nova.tests.compute.test_resource_tracker.NoInstanceTypesInSysMetadata:4: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.938 | /home/jenkins/workspace/gate-nova-docs/nova/tests/db/test_migrations.py:docstring of nova.tests.db.test_migrations:21: ERROR: Unexpected indentation.
2014-08-01 03:40:18.940 | /home/jenkins/workspace/gate-nova-docs/nova/tests/db/test_migrations.py:docstring of nova.tests.db.test_migrations:22: WARNING: Block quote ends without a blank line; unexpected unindent.
2014-08-01 03:40:18.941 | /home/jenkins/workspace/gate-nova-docs/nova/tests/db/test_migrations.py:docstring of nova.tests.db.test_migrations:24: ERROR: Unexpected indentation.
2014-08-01 03:40:18.942 | /home/jenkins/workspace/gate-nova-docs/nova/tests/image_fixtures.py:docstring of nova.tests.image_fixtures.get_image_fixtures:10: SEVERE: Unexpected section title.
2014-08-01 03:40:18.942 |

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/111297
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=11aaf21d9e239c0b017a89f82f678d264f0d403b
Submitter: Jenkins
Branch: master

commit 11aaf21d9e239c0b017a89f82f678d264f0d403b
Author: Davanum Srinivas <email address hidden>
Date: Fri Aug 1 10:33:41 2014 -0400

    docs - Fix errors,warnings from document generation

    SEVERE: Unexpected section title.
    ERROR: Unexpected indentation.
    WARNING: Block quote ends without a blank line; unexpected unindent.
    WARNING: Definition list ends without a blank line; unexpected unindent.
    WARNING: Field list ends without a blank line; unexpected unindent.
    WARNING: Inline emphasis start-string without end-string.
    WARNING: Inline interpreted text or phrase reference start-string without end-string.
    WARNING: Inline strong start-string without end-string.

    Partial-Bug: #1351350

    Change-Id: I661e0e32519f8e4de3325efd10242824015ed03d

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/112723
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=a3d274303ef8d1a123fcfb4ae3ba85e9712fe470
Submitter: Jenkins
Branch: master

commit a3d274303ef8d1a123fcfb4ae3ba85e9712fe470
Author: Davanum Srinivas <email address hidden>
Date: Thu Aug 7 19:22:26 2014 -0400

    docs - Fix errors,warnings from document generation

    ERROR: Unexpected indentation.
    WARNING: Field list ends without a blank line; unexpected unindent.
    WARNING: Block quote ends without a blank line; unexpected unindent.

    Partial-Bug: #1351350

    Change-Id: If13b5c533cf9a1e8f543b8f679c464c0dc007a30

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/111298
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=a507d42cf5d9912c2b3622e84afb8b7d3278595b
Submitter: Jenkins
Branch: master

commit a507d42cf5d9912c2b3622e84afb8b7d3278595b
Author: Davanum Srinivas <email address hidden>
Date: Fri Aug 1 10:36:28 2014 -0400

    docs - Set pbr 'warnerrors' option for doc build

    By setting this pbr option in setup.cfg, the doc build will fail in case
    of any warnings or errors occur during the build process.

    Closes-Bug: #1351350

    Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d