Browse Source

Ensure that doc linting is included in the linters test

The 'docs' tox target executes the doc8 lint test which may result in
failures when testing documentation builds, but OpenStack-CI does not
execute that tox target.

In order to ensure that we catch all standard documentation syntax
errors and prevent them from merging, this patch includes the docs
target in the 'linters' chain of tests.

Fixes for any failures which result from executing this test are also
included in the patch.

Change-Id: I2794185c0fce4c5fb027cb63d20850c72c4a91a4
tags/14.0.0.0b2^0
Jesse Pretorius 2 years ago
parent
commit
db40d5997b
3 changed files with 3 additions and 1 deletions
  1. 1
    0
      README.rst
  2. 1
    1
      doc/source/index.rst
  3. 1
    0
      tox.ini

+ 1
- 0
README.rst View File

@@ -25,3 +25,4 @@ Example Playbook
25 25
       user: root
26 26
       roles:
27 27
         - { role: "memcached_server" }
28
+

+ 1
- 1
doc/source/index.rst View File

@@ -1 +1 @@
1
-.. include:: ../../README.rst
1
+.. include:: ../../README.rst

+ 1
- 0
tox.ini View File

@@ -180,3 +180,4 @@ commands =
180 180
     {[testenv:bashate]commands}
181 181
     {[testenv:ansible-lint]commands}
182 182
     {[testenv:ansible-syntax]commands}
183
+    {[testenv:docs]commands}

Loading…
Cancel
Save