aboutsummaryrefslogtreecommitdiff
path: root/tox.ini
diff options
context:
space:
mode:
authorPierre Riteau <pierre@stackhpc.com>2024-12-05 10:45:33 +0100
committerPierre Riteau <pierre@stackhpc.com>2024-12-05 10:45:33 +0100
commit0bd1313f598af571ec12e30b211018042ece5346 (patch)
treefd87017bfd9e08e2b1a915b14e0d6af6ff6c5cd9 /tox.ini
parent7f85beac3ff71a3660df5357f0136d722d64d519 (diff)
downloadkolla-ansible-0bd1313f598af571ec12e30b211018042ece5346.tar.gz
kolla-ansible-0bd1313f598af571ec12e30b211018042ece5346.zip
docs: minor fixes to external Ceph guide
When a path is broken into two separate lines, the generated HTML includes an incorrect space character in the middle of the path. We need to ignore doc8 linting on this file as this change breaks the max line length check. I tried using ``ignore-path-errors`` to exclude only D001 for this file, but doc8 does not like a relative path for this option [1]. [1] https://github.com/PyCQA/doc8/issues/162 Change-Id: I1cf0b7a6b7506a68876bce2de5080718280a47be
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini5
1 files changed, 5 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
index 10a2ce517..6b36c1eec 100644
--- a/tox.ini
+++ b/tox.ini
@@ -126,6 +126,11 @@ show-source = True
ignore = W504
exclude = .eggs,.git,.tox,doc
+[doc8]
+# NOTE(priteau): We break max line length in this file to avoid inserting
+# erroneous space characters inside file paths
+ignore-path = doc/source/reference/storage/external-ceph-guide.rst
+
[testenv:doc8]
deps = {[testenv:linters]deps}
commands =