Browse Source

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
changes/84/441584/3
Andreas Jaeger 5 years ago
committed by Rico Lin
parent
commit
6529a2ebd7
  1. 2
      api-ref/source/v1/events.inc
  2. 20
      api-ref/source/v1/parameters.yaml
  3. 2
      api-ref/source/v1/samples/stack-outputs-list-response.json
  4. 2
      api-ref/source/v1/stack-templates.inc
  5. 4
      api-ref/source/v1/stacks.inc
  6. 2
      api-ref/source/v1/versions.inc
  7. 6
      tox.ini

2
api-ref/source/v1/events.inc

@ -97,7 +97,7 @@ Request Parameters
- stack_name: stack_name_url
Response Parameters
------------------
-------------------
.. rest_parameters:: parameters.yaml

20
api-ref/source/v1/parameters.yaml

@ -48,16 +48,16 @@ output_key_url:
in: path
required: true
type: string
resource_name_url:
resource_name_or_physical_id_url:
description: |
The name of a resource in the stack.
The name of a resource in the stack, or the ID of its underlying physical
resource.
in: path
required: true
type: string
resource_name_or_physical_id_url:
resource_name_url:
description: |
The name of a resource in the stack, or the ID of its underlying physical
resource.
The name of a resource in the stack.
in: path
required: true
type: string
@ -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",

2
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"
}
]
}

2
api-ref/source/v1/stack-templates.inc

@ -81,7 +81,7 @@ Request Parameters
- template_version: template_version_url
Response Parameters
------------------
-------------------
.. rest_parameters:: parameters.yaml

4
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.

2
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

6
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 =

Loading…
Cancel
Save