Merge "Fix docs errors and warnings"

HACKING.rst

@@ -132,16 +132,18 @@ overwritten by subclasses (enforced via hacking rule T105).
 
 Set-up is split in a series of steps (setup stages), which can be overwritten
 by test classes. Set-up stages are:
- - `skip_checks`
+
- - `setup_credentials`
+- `skip_checks`
- - `setup_clients`
+- `setup_credentials`
- - `resource_setup`
+- `setup_clients`
+- `resource_setup`
 
 Tear-down is also split in a series of steps (teardown stages), which are
 stacked for execution only if the corresponding setup stage had been
 reached during the setup phase. Tear-down stages are:
- - `clear_credentials` (defined in the base test class)
+
- - `resource_cleanup`
+- `clear_credentials` (defined in the base test class)
+- `resource_cleanup`
 
 Skipping Tests
 --------------

doc/source/configuration.rst

@@ -348,11 +348,14 @@ endpoint type instead of publicURL for a service that these need to be changed.
     service catalog should be in a standard format (which is going to be
     standardized at the keystone level).
     Tempest expects URLs in the Service catalog in the following format:
-     * ``http://example.com:1234/<version-info>``
+
+    * ``http://example.com:1234/<version-info>``
+
     Examples:
-     * Good - ``http://example.com:1234/v2.0``
+
-     * Wouldn’t work -  ``http://example.com:1234/xyz/v2.0/``
+    * Good - ``http://example.com:1234/v2.0``
-       (adding prefix/suffix around version etc)
+    * Wouldn’t work -  ``http://example.com:1234/xyz/v2.0/``
+      (adding prefix/suffix around version etc)
 
 Service Feature Configuration
 -----------------------------

doc/source/microversion_testing.rst

@@ -24,6 +24,7 @@ Configuration options for Microversion
 
   Those should be defined under respective section of each service.
   For example::
+
       [compute]
       min_microversion = None
       max_microversion = latest
@@ -159,7 +160,8 @@ Below test is applicable for Microversion from 2.10 till latest::
 
 
 Notes about Compute Microversion Tests
-"""""""""""""""""""""""""""""""""""
+""""""""""""""""""""""""""""""""""""""
+
 Some of the compute Microversion tests have been already implemented
 with the Microversion testing framework. So for further tests only
 step 4 is needed.

tempest/lib/services/compute/base_compute_client.py

@@ -67,11 +67,13 @@ class BaseComputeClient(rest_client.RestClient):
 
         :param schema_versions_info: List of dict which provides schema
                                      information with range of valid versions.
-        Example -
+
-        schema_versions_info = [
+        Example::
-            {'min': None, 'max': '2.1', 'schema': schemav21},
+
-            {'min': '2.2', 'max': '2.9', 'schema': schemav22},
+         schema_versions_info = [
-            {'min': '2.10', 'max': None, 'schema': schemav210}]
+             {'min': None, 'max': '2.1', 'schema': schemav21},
+             {'min': '2.2', 'max': '2.9', 'schema': schemav22},
+             {'min': '2.10', 'max': None, 'schema': schemav210}]
         """
         schema = None
         version = api_version_request.APIVersionRequest(COMPUTE_MICROVERSION)