Reenable some doc8 tests
Enable doc8 but disable D000 (RST validation) and D001 test (overlong lines). This also disables all the problems we had in the past with doc8 checking, the current files pass doc8 after fixing a few minor problems (part of change). This basically tests for whitespace. Change-Id: I648ac7f78b3a31f3b1434dc7d7d0b887ce4d5128
This commit is contained in:
parent
8bc1939c0b
commit
21ea9aff19
@ -17,5 +17,5 @@ Virtual extensible local area network (VXLAN)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A VXLAN, virtual extensible local area network, allows the creation of
|
||||
a logical network for virtual machines across various networks. VXLAN
|
||||
encapsulates layer-2 Ethernet frames over layer-4 UDP packets.
|
||||
a logical network for virtual machines across various networks. VXLAN
|
||||
encapsulates layer-2 Ethernet frames over layer-4 UDP packets.
|
||||
|
@ -141,7 +141,7 @@ following example defines a default value ``m1.small`` for the
|
||||
label: Instance Type
|
||||
description: Flavor to be used
|
||||
default: m1.small
|
||||
|
||||
|
||||
.. note::
|
||||
If a template doesn't define a default value for a parameter, then the user
|
||||
must define the value, otherwise the stack creation will fail.
|
||||
|
@ -104,7 +104,7 @@ in the stack. This can be done with the :code:`str_replace` intrinsic function:
|
||||
# ...
|
||||
params:
|
||||
$FOO: {get_param: foo}
|
||||
|
||||
|
||||
.. warning:: If a stack-update is performed and there are any changes
|
||||
at all to the content of user_data then the server will be replaced
|
||||
(deleted and recreated) so that the modified boot configuration can be
|
||||
|
@ -209,7 +209,7 @@ the following syntax:
|
||||
constraints:
|
||||
- <constraint type>: <constraint definition>
|
||||
description: <constraint description>
|
||||
|
||||
|
||||
constraint type
|
||||
Type of constraint to apply. The set of currently supported constraints is
|
||||
given below.
|
||||
@ -349,7 +349,7 @@ For example:
|
||||
constraints:
|
||||
- allowed_pattern: "[A-Z]+[a-zA-Z0-9]*"
|
||||
description: User name must start with an uppercase character
|
||||
|
||||
|
||||
custom_constraint
|
||||
+++++++++++++++++
|
||||
The :code:`custom_constraint`` constraint adds an extra step of validation,
|
||||
@ -608,7 +608,7 @@ The following example demonstrates how to use the :code:`get_param` function:
|
||||
instance_private_ip:
|
||||
description: Private IP address of the deployed compute instance
|
||||
value: { get_attr: [my_instance, networks, private, 0] }
|
||||
|
||||
|
||||
In this example, if the networks attribute contained the following data:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
@ -12,3 +12,4 @@ openstack-doc-tools>=0.23
|
||||
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
|
||||
openstackdocstheme>=1.0.3
|
||||
oslosphinx>=2.5.0,<2.6.0 # Apache-2.0
|
||||
doc8 # Apache-2.0
|
||||
|
5
tox.ini
5
tox.ini
@ -25,6 +25,7 @@ commands = openstack-doc-test --check-links {posargs}
|
||||
commands =
|
||||
openstack-doc-test --check-niceness {posargs}
|
||||
flake8
|
||||
doc8 doc
|
||||
|
||||
[testenv:checksyntax]
|
||||
commands =
|
||||
@ -141,6 +142,10 @@ commands = {toxinidir}/tools/generatepot-rst.sh {posargs}
|
||||
ignore-path = doc/*/target,doc/*/build
|
||||
# File extensions to use
|
||||
extensions = .rst,.txt
|
||||
# Disable some doc8 checks:
|
||||
# D000: Check RST validity (cannot handle lineos directive)
|
||||
# D001: Ignore lines longer than 79 chars
|
||||
ignore = D000, D001
|
||||
|
||||
[flake8]
|
||||
show-source = True
|
||||
|
Loading…
Reference in New Issue
Block a user