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
This commit is contained in:
parent
0e14807eb4
commit
6529a2ebd7
|
@ -97,7 +97,7 @@ Request Parameters
|
||||||
- stack_name: stack_name_url
|
- stack_name: stack_name_url
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
|
@ -48,12 +48,6 @@ output_key_url:
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
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:
|
resource_name_or_physical_id_url:
|
||||||
description: |
|
description: |
|
||||||
The name of a resource in the stack, or the ID of its underlying physical
|
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
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
resource_name_url:
|
||||||
|
description: |
|
||||||
|
The name of a resource in the stack.
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
snapshot_id_url:
|
snapshot_id_url:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the snapshot.
|
The UUID of the snapshot.
|
||||||
|
@ -717,7 +717,7 @@ files:
|
||||||
value provides the contents of the file. The following code shows
|
value provides the contents of the file. The following code shows
|
||||||
the general structure of this parameter.
|
the general structure of this parameter.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
{ ...
|
{ ...
|
||||||
"files": {
|
"files": {
|
||||||
|
@ -734,7 +734,7 @@ files:
|
||||||
map with the path to the file as the name and the file contents as
|
map with the path to the file as the name and the file contents as
|
||||||
the value. So, a simple example looks like this:
|
the value. So, a simple example looks like this:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
{
|
{
|
||||||
"files": {
|
"files": {
|
||||||
|
@ -943,7 +943,7 @@ parameters:
|
||||||
In the example, ``a`` and ``b`` would be the names of two
|
In the example, ``a`` and ``b`` would be the names of two
|
||||||
parameters defined in the template.
|
parameters defined in the template.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
{ ...
|
{ ...
|
||||||
"parameters": {
|
"parameters": {
|
||||||
|
@ -982,7 +982,7 @@ parameters:
|
||||||
map with the path to the file as the name and the file contents as
|
map with the path to the file as the name and the file contents as
|
||||||
the value. So, a simple example looks like this:
|
the value. So, a simple example looks like this:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
{
|
{
|
||||||
"files": {
|
"files": {
|
||||||
|
@ -1463,7 +1463,7 @@ template:
|
||||||
The content of the string is a JSON- or YAML-formatted Orchestration
|
The content of the string is a JSON- or YAML-formatted Orchestration
|
||||||
template. For example:
|
template. For example:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
"template": {
|
"template": {
|
||||||
"heat_template_version": "2013-05-23",
|
"heat_template_version": "2013-05-23",
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
"outputs": [
|
"outputs": [
|
||||||
{
|
{
|
||||||
"output_key": "output name",
|
"output_key": "output name",
|
||||||
"description": "output description",
|
"description": "output description"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
@ -81,7 +81,7 @@ Request Parameters
|
||||||
- template_version: template_version_url
|
- template_version: template_version_url
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
|
@ -634,7 +634,7 @@ Request Parameters
|
||||||
- stack_identity: stack_identity
|
- stack_identity: stack_identity
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
@ -682,7 +682,7 @@ Request Parameters
|
||||||
- stack_id: stack_id_url
|
- stack_id: stack_id_url
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
------------------
|
-------------------
|
||||||
|
|
||||||
This request does not return anything in the response body.
|
This request does not return anything in the response body.
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ Request Parameters
|
||||||
This operation does not accept a request body.
|
This operation does not accept a request body.
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
|
6
tox.ini
6
tox.ini
|
@ -47,15 +47,11 @@ commands = python setup.py build_sphinx
|
||||||
[testenv:api-ref]
|
[testenv:api-ref]
|
||||||
# This environment is called from CI scripts to test and publish
|
# This environment is called from CI scripts to test and publish
|
||||||
# the API Ref to developer.openstack.org.
|
# 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
|
whitelist_externals = bash
|
||||||
rm
|
rm
|
||||||
commands =
|
commands =
|
||||||
rm -rf api-ref/build
|
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]
|
[testenv:genconfig]
|
||||||
commands =
|
commands =
|
||||||
|
|
Loading…
Reference in New Issue