From 6529a2ebd7b46039feae45d7314d9764ce7ac4e8 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 4 Mar 2017 09:30:53 +0100 Subject: [PATCH] Fix api-ref build with Sphinx 1.5 Sphinx 1.5 is more picky about some code, it complaints if code-blocks are not valid json and also about too short underlines. Fix one json file, fix underlines, change code-blocks to none so that Sphinx 1.5 builds this again. Enable treating warnings as errors to avoid regressions. Note that with current tools there are no double stanza warnings anymore. Change-Id: I58d1452ffddf091d56dcfad8140caba084800a0e --- api-ref/source/v1/events.inc | 2 +- api-ref/source/v1/parameters.yaml | 22 +++++++++---------- .../samples/stack-outputs-list-response.json | 2 +- api-ref/source/v1/stack-templates.inc | 2 +- api-ref/source/v1/stacks.inc | 4 ++-- api-ref/source/v1/versions.inc | 2 +- tox.ini | 6 +---- 7 files changed, 18 insertions(+), 22 deletions(-) diff --git a/api-ref/source/v1/events.inc b/api-ref/source/v1/events.inc index 9980ba8de1..a0f72ece21 100644 --- a/api-ref/source/v1/events.inc +++ b/api-ref/source/v1/events.inc @@ -97,7 +97,7 @@ Request Parameters - stack_name: stack_name_url Response Parameters ------------------- +------------------- .. rest_parameters:: parameters.yaml diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index a07c9cb78d..68c832c10a 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -48,12 +48,6 @@ output_key_url: in: path required: true type: string -resource_name_url: - description: | - The name of a resource in the stack. - in: path - required: true - type: string resource_name_or_physical_id_url: description: | The name of a resource in the stack, or the ID of its underlying physical @@ -61,6 +55,12 @@ resource_name_or_physical_id_url: in: path required: true type: string +resource_name_url: + description: | + The name of a resource in the stack. + in: path + required: true + type: string snapshot_id_url: description: | The UUID of the snapshot. @@ -717,7 +717,7 @@ files: value provides the contents of the file. The following code shows the general structure of this parameter. - .. code-block:: json + .. code-block:: none { ... "files": { @@ -734,7 +734,7 @@ files: map with the path to the file as the name and the file contents as the value. So, a simple example looks like this: - .. code-block:: json + .. code-block:: none {    "files": { @@ -943,7 +943,7 @@ parameters: In the example, ``a`` and ``b`` would be the names of two parameters defined in the template. - .. code-block:: json + .. code-block:: none { ... "parameters": { @@ -982,7 +982,7 @@ parameters: map with the path to the file as the name and the file contents as the value. So, a simple example looks like this: - .. code-block:: json + .. code-block:: none { "files": { @@ -1463,7 +1463,7 @@ template: The content of the string is a JSON- or YAML-formatted Orchestration template. For example: - .. code-block:: json + .. code-block:: none "template": { "heat_template_version": "2013-05-23", diff --git a/api-ref/source/v1/samples/stack-outputs-list-response.json b/api-ref/source/v1/samples/stack-outputs-list-response.json index ce9fabebbe..97f000aaec 100644 --- a/api-ref/source/v1/samples/stack-outputs-list-response.json +++ b/api-ref/source/v1/samples/stack-outputs-list-response.json @@ -2,7 +2,7 @@ "outputs": [ { "output_key": "output name", - "description": "output description", + "description": "output description" } ] } diff --git a/api-ref/source/v1/stack-templates.inc b/api-ref/source/v1/stack-templates.inc index 0ee9856a37..e9b735871a 100644 --- a/api-ref/source/v1/stack-templates.inc +++ b/api-ref/source/v1/stack-templates.inc @@ -81,7 +81,7 @@ Request Parameters - template_version: template_version_url Response Parameters ------------------- +------------------- .. rest_parameters:: parameters.yaml diff --git a/api-ref/source/v1/stacks.inc b/api-ref/source/v1/stacks.inc index 32537760bc..241d21377a 100644 --- a/api-ref/source/v1/stacks.inc +++ b/api-ref/source/v1/stacks.inc @@ -634,7 +634,7 @@ Request Parameters - stack_identity: stack_identity Response Parameters ------------------- +------------------- .. rest_parameters:: parameters.yaml @@ -682,7 +682,7 @@ Request Parameters - stack_id: stack_id_url Response Parameters ------------------- +------------------- This request does not return anything in the response body. diff --git a/api-ref/source/v1/versions.inc b/api-ref/source/v1/versions.inc index 8fbcaa5e59..79bbd88361 100644 --- a/api-ref/source/v1/versions.inc +++ b/api-ref/source/v1/versions.inc @@ -24,7 +24,7 @@ Request Parameters This operation does not accept a request body. Response Parameters ------------------- +------------------- .. rest_parameters:: parameters.yaml diff --git a/tox.ini b/tox.ini index 9871a879c4..745b852255 100644 --- a/tox.ini +++ b/tox.ini @@ -47,15 +47,11 @@ commands = python setup.py build_sphinx [testenv:api-ref] # This environment is called from CI scripts to test and publish # the API Ref to developer.openstack.org. -# -# we do not used -W here because we are doing some slightly tricky -# things to build a single page document, and as such, we are ok -# ignoring the duplicate stanzas warning. whitelist_externals = bash rm commands = rm -rf api-ref/build - sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:genconfig] commands =