Fix doc CI failure

Change-Id: Ie7fa0d9882821273c9f0a2bdf3609260743804de
This commit is contained in:
xywang 2018-06-08 11:19:57 +08:00
parent 684ab20f96
commit 06f40b8beb
3 changed files with 8 additions and 18 deletions

View File

@ -38,7 +38,7 @@ commands = {posargs}
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -b html doc/source doc/build/html
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt

View File

@ -32,15 +32,10 @@ class Client(object):
:type url: `six.text_type`
:param version: API Version pointing to.
:type version: `int`
:param options: Extra options:
- client_uuid: Custom client uuid. A new one
will be generated, if not passed.
- auth_opts: Authentication options:
- backend
- options
:param conf: CONF object.
:type conf: `oslo_config.cfg.CONF`
:param session: keystone session. But it's just place holder, we wont'
support it in v1.
:type options: `dict`
"""
queues_module = queues
@ -148,7 +143,7 @@ class Client(object):
"""Gets a list of pools from the server
:param params: Filters to use for getting pools
:type params: **kwargs dict.
:type params: dict.
:returns: A list of pools
:rtype: `list`
@ -179,7 +174,7 @@ class Client(object):
"""Gets a list of flavors from the server
:param params: Filters to use for getting flavors
:type params: **kwargs dict.
:type params: dict.
:returns: A list of flavors
:rtype: `list`

View File

@ -29,13 +29,8 @@ class Client(client.Client):
:type url: `six.text_type`
:param version: API Version pointing to.
:type version: `int`
:param options: Extra options:
- client_uuid: Custom client uuid. A new one
will be generated, if not passed.
- auth_opts: Authentication options:
- backend
- options
:type options: `dict`
:param conf: CONF object.
:type conf: `oslo_config.cfg.CONF`
"""
queues_module = queues
@ -78,7 +73,7 @@ class Client(client.Client):
"""Gets a list of subscriptions from the server
:param params: Filters to use for getting subscriptions
:type params: **kwargs dict.
:type params: dict.
:returns: A list of subscriptions
:rtype: `list`