Building keystoneclient docs generates several warnings

Bug #1315523 reported by Steve Martinelli
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-keystoneclient
Fix Released
Low
Brant Knudson

Bug Description

When running tox -e docs, the following warnings are produced:

/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute generic
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute v2_0
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute v3
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute access
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute client
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute exceptions
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute httpclient
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.__init__, attribute service_catalog
/opt/stack/python-keystoneclient/keystoneclient/service_catalog.py:docstring of keystoneclient.service_catalog.ServiceCatalog.url_for:17: WARNING: Field list ends without a blank line; unexpected unindent.
/opt/stack/python-keystoneclient/doc/source/api/keystoneclient.apiclient.rst:7: WARNING: missing attribute mentioned in :members: or __all__: module keystoneclient.apiclient, attribute exceptions
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/auth.py:docstring of keystoneclient.openstack.common.apiclient.auth.BaseAuthPlugin.token_and_endpoint:7: ERROR: Unexpected indentation.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/base.py:docstring of keystoneclient.openstack.common.apiclient.base.HookableMixin.run_hooks:5: WARNING: Inline strong start-string without end-string.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/base.py:docstring of keystoneclient.openstack.common.apiclient.base.HookableMixin.run_hooks:6: WARNING: Inline strong start-string without end-string.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/client.py:docstring of keystoneclient.openstack.common.apiclient.client.HTTPClient:5: ERROR: Unexpected indentation.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/client.py:docstring of keystoneclient.openstack.common.apiclient.client.HTTPClient:6: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/client.py:docstring of keystoneclient.openstack.common.apiclient.client.HTTPClient.client_request:11: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/stack/python-keystoneclient/keystoneclient/openstack/common/apiclient/client.py:docstring of keystoneclient.openstack.common.apiclient.client.HTTPClient.request:9: WARNING: Block quote ends without a blank line; unexpected unindent.
/opt/stack/python-keystoneclient/keystoneclient/v3/contrib/trusts.py:docstring of keystoneclient.v3.contrib.trusts.TrustManager.create:9: ERROR: Unexpected indentation.

The trust and service catalog ones should be easy to fix, but we would have to fix the ones in oslo and then update keystoneclient.

Revision history for this message
Brant Knudson (blk-u) wrote :

The fix for the oslo-incubator doc build issues are here: https://review.openstack.org/#/c/73879/

Revision history for this message
Openstack Gerrit (openstack-gerrit) wrote : Fix merged to python-keystoneclient (master)

Reviewed: https://review.openstack.org/91893
Committed: https://git.openstack.org/cgit/openstack/python-keystoneclient/commit/?id=8cf2829d536ed6a6fcaec91d090d4b04f74b96c0
Submitter: Jenkins
Branch: master

commit 8cf2829d536ed6a6fcaec91d090d4b04f74b96c0
Author: Steve Martinelli <email address hidden>
Date: Fri May 2 15:38:49 2014 -0500

    Fix docstrings in keystoneclient

    Trusts and service catalog had a few malformed docstrings
    that caused warnings when building docs.

    Change-Id: Iea8612c3aaebea54c00b02c73c77f0c9e79f86bc
    Partial-Bug: #1315523

Dolph Mathews (dolph)
Changed in python-keystoneclient:
importance: Undecided → Low
status: New → Triaged
status: Triaged → In Progress
assignee: nobody → Steve Martinelli (stevemar)
milestone: 1.0.0 → 0.9.0
milestone: 0.9.0 → none
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to python-keystoneclient (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/95845

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to python-keystoneclient (master)

Reviewed: https://review.openstack.org/95845
Committed: https://git.openstack.org/cgit/openstack/python-keystoneclient/commit/?id=54cc999a4def0bcf6faef4da9bc2f7caf131044f
Submitter: Jenkins
Branch: master

commit 54cc999a4def0bcf6faef4da9bc2f7caf131044f
Author: Steve Martinelli <email address hidden>
Date: Tue May 27 13:53:58 2014 -0400

    Sync with oslo-incubator caed79d

    This syncs python-keystoneclient with oslo-incubator commit hash
    caed79d8239679cb74476bb0d9e5011b4fcc39da

    First, remove the existing code to cleanup:
     $ rm -r keystoneclient/openstack/*

    Then, sync from oslo-incubator:
     $ python update.py ../python-keystoneclient

    Commits since last sync (2640847):
    ----------------------------------
    1173e46 Remove ValueError when accessing sys.modules
    90ae24b Remove redundant default=None for config options
    18f2bc1 Enforce unicode json output for jsonutils.load[s]()
    4a777e5 Fix warnings in doc build for apiclient

    Related-Bug: #1315523
    Closes-Bug: #1314129
    Change-Id: Id53ea2d4828e81bc6270f186849f391e7bc73101

Changed in python-keystoneclient:
assignee: Steve Martinelli (stevemar) → Brant Knudson (blk-u)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-keystoneclient (master)

Reviewed: https://review.openstack.org/99745
Committed: https://git.openstack.org/cgit/openstack/python-keystoneclient/commit/?id=6659902a731767b3405d68e515c8edcc3af81119
Submitter: Jenkins
Branch: master

commit 6659902a731767b3405d68e515c8edcc3af81119
Author: Brant Knudson <email address hidden>
Date: Thu Jun 12 14:40:56 2014 -0500

    Imports to fix build warnings

    There were warnings generated during the build due to missing
    attributes, like this:

     keystoneclient.rst:7: WARNING: missing attribute mentioned in
       :members: or __all__: module keystoneclient.__init__, attribute
       v2_0

    This is fixed by importing the symbol in __init__.

    Closes-Bug: #1315523

    Change-Id: I565c78ef8910353c4e1ce1641b42fba7cdbd77d8

Changed in python-keystoneclient:
status: In Progress → Fix Committed
Dolph Mathews (dolph)
Changed in python-keystoneclient:
milestone: none → 0.10.0
Dolph Mathews (dolph)
Changed in python-keystoneclient:
status: Fix Committed → Fix Released
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.