diff --git a/doc/networking-guide/source/intro_tunnel_technologies.rst b/doc/networking-guide/source/intro_tunnel_technologies.rst index bfcf886ced..41ddde1829 100644 --- a/doc/networking-guide/source/intro_tunnel_technologies.rst +++ b/doc/networking-guide/source/intro_tunnel_technologies.rst @@ -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. \ No newline at end of file +a logical network for virtual machines across various networks. VXLAN +encapsulates layer-2 Ethernet frames over layer-4 UDP packets. diff --git a/doc/user-guides/source/enduser/hot-guide/hot_hello_world.rst b/doc/user-guides/source/enduser/hot-guide/hot_hello_world.rst index e4b6fedd8b..dda0f5f66a 100644 --- a/doc/user-guides/source/enduser/hot-guide/hot_hello_world.rst +++ b/doc/user-guides/source/enduser/hot-guide/hot_hello_world.rst @@ -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. diff --git a/doc/user-guides/source/enduser/hot-guide/hot_software_deployment.rst b/doc/user-guides/source/enduser/hot-guide/hot_software_deployment.rst index 1de4d5c287..4c1d3f40dc 100644 --- a/doc/user-guides/source/enduser/hot-guide/hot_software_deployment.rst +++ b/doc/user-guides/source/enduser/hot-guide/hot_software_deployment.rst @@ -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 diff --git a/doc/user-guides/source/enduser/hot-guide/hot_spec.rst b/doc/user-guides/source/enduser/hot-guide/hot_spec.rst index dfee03d057..dca41ad2e4 100644 --- a/doc/user-guides/source/enduser/hot-guide/hot_spec.rst +++ b/doc/user-guides/source/enduser/hot-guide/hot_spec.rst @@ -209,7 +209,7 @@ the following syntax: constraints: - : 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 diff --git a/test-requirements.txt b/test-requirements.txt index 2e00ce3b73..ad64b56add 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -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 diff --git a/tox.ini b/tox.ini index b2e1100afd..b66bf6c623 100644 --- a/tox.ini +++ b/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