Warnings and errors when generating docs

Bug #1557235 reported by Tom Cocozzello
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Glance Client
Fix Released
Undecided
Unassigned

Bug Description

There are many warnings and errors when docs are generated.

This can be be reproduced by `tox -e docs`

/home/tom/Documents/python-glanceclient/glanceclient/v2/metadefs.py:docstring of glanceclient.v2.metadefs.NamespaceController.list:14: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tom/Documents/python-glanceclient/glanceclient/v2/tasks.py:docstring of glanceclient.v2.tasks.Controller.list:4: WARNING: Field list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/tom/Documents/python-glanceclient/doc/source/apiv2.rst:: WARNING: document isn't included in any toctree
/home/tom/Documents/python-glanceclient/doc/source/man/glance.rst:: WARNING: document isn't included in any toctree

/home/tom/Documents/python-glanceclient/glanceclient/v2/metadefs.py:docstring of glanceclient.v2.metadefs.NamespaceController.list:14: WARNING: Field list ends without a blank line; unexpected unindent.
/home/tom/Documents/python-glanceclient/glanceclient/v2/tasks.py:docstring of glanceclient.v2.tasks.Controller.list:4: WARNING: Field list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found

checking consistency... /home/tom/Documents/python-glanceclient/doc/source/apiv2.rst:: WARNING: document isn't included in any toctree
/home/tom/Documents/python-glanceclient/doc/source/man/glance.rst:: WARNING: document isn't included in any toctree

Changed in python-glanceclient:
assignee: nobody → Tom Cocozzello (tjcocozz)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-glanceclient (master)

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

Changed in python-glanceclient:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-glanceclient (master)

Reviewed: https://review.openstack.org/293724
Committed: https://git.openstack.org/cgit/openstack/python-glanceclient/commit/?id=c6904d033265a61143a7fa39a0108741ba3856ff
Submitter: Jenkins
Branch: master

commit c6904d033265a61143a7fa39a0108741ba3856ff
Author: Tom Cocozzello <email address hidden>
Date: Wed Mar 16 16:34:46 2016 -0500

    Docs are generated incorrectly

    When docs are generated with pbr command 'warnerrors = True'
    there are many doc problems that are shown. This patch fixes
    these problems.

    Change-Id: Idb804ab924782b6d7d379494987bdba2acbce568
    Closes-Bug: #1557235

Changed in python-glanceclient:
status: In Progress → Fix Released
Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/python-glanceclient 2.1.0

This issue was fixed in the openstack/python-glanceclient 2.1.0 release.

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

Other bug subscribers

Remote bug watches

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