From aca816da2068057df04e0a5b1b60f2221d03aae6 Mon Sep 17 00:00:00 2001 From: Ken'ichi Ohmichi Date: Fri, 27 Jan 2017 15:12:17 -0800 Subject: [PATCH] Enable sphinx on servers_client servers_client is most useful client for testing, but the docstring was not enabled on the site. So this patch makes it enabled. Change-Id: I031de923deab74bc0f84cff52f470ab233b7dbba --- doc/source/library/clients.rst | 15 ++++++++++++--- .../library/service_clients/compute_clients.rst | 7 +++++++ tempest/lib/services/compute/servers_client.py | 2 ++ 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 doc/source/library/service_clients/compute_clients.rst diff --git a/doc/source/library/clients.rst b/doc/source/library/clients.rst index 086cfc97bd..0f4ba4c1a8 100644 --- a/doc/source/library/clients.rst +++ b/doc/source/library/clients.rst @@ -16,9 +16,18 @@ service client module from a set of shared parameters. The ``ServiceClients`` class provides a convenient way to get access to all available service clients initialized with a provided set of credentials. ------------------- -The clients module ------------------- +----------------------------- +The clients management module +----------------------------- .. automodule:: tempest.lib.services.clients :members: + +------------------------------ +Compute service client modules +------------------------------ + +.. toctree:: + :maxdepth: 2 + + service_clients/compute_clients diff --git a/doc/source/library/service_clients/compute_clients.rst b/doc/source/library/service_clients/compute_clients.rst new file mode 100644 index 0000000000..4ca55d4184 --- /dev/null +++ b/doc/source/library/service_clients/compute_clients.rst @@ -0,0 +1,7 @@ +.. _servers_client: + +Compute Client Usage +==================== + +.. automodule:: tempest.lib.services.compute.servers_client + :members: diff --git a/tempest/lib/services/compute/servers_client.py b/tempest/lib/services/compute/servers_client.py index 50ce32ed49..f16ef88286 100644 --- a/tempest/lib/services/compute/servers_client.py +++ b/tempest/lib/services/compute/servers_client.py @@ -30,6 +30,8 @@ from tempest.lib.services.compute import base_compute_client class ServersClient(base_compute_client.BaseComputeClient): + """Service client for the resource /servers""" + schema_versions_info = [ {'min': None, 'max': '2.2', 'schema': schema}, {'min': '2.3', 'max': '2.8', 'schema': schemav23},