[tox] add doc8 target to test documentation
authorArthur Lutz <arthur.lutz@logilab.fr>
Fri, 06 Dec 2019 13:21:56 +0100
changeset 12793 752de3f8cb3e
parent 12792 e2cdb1be6bd9
child 12794 9c6dc1b071e3
[tox] add doc8 target to test documentation
tox.ini
--- a/tox.ini	Thu Apr 04 17:11:14 2019 +0200
+++ b/tox.ini	Fri Dec 06 13:21:56 2019 +0100
@@ -1,7 +1,8 @@
 [tox]
 envlist =
   check-manifest,flake8,
-  py3-{server,web,misc}
+  py3-{server,web,misc},
+  doc8
 
 [testenv]
 basepython=python3
@@ -40,6 +41,11 @@
 commands =
   {envpython} -m check_manifest {toxinidir}
 
+[testenv:doc8]
+skip_install = true
+commands=
+    doc8 --ignore-path doc/_build --ignore-path .tox --ignore-path .hg doc
+
 [pytest]
 python_files = *test_*.py
 log_print = false
@@ -50,5 +56,14 @@
 max-line-length = 100
 exclude = doc/*,.tox/*
 
+[doc8]
+#max-line-length=199
+#ignore-path-errors=SOURCES.txt;D005
+# D000 - Interpreted text role "index" everywhere
+# D001 - line too long... to much of it right now
+ignore=D000,D001,D005
+# FIXME - can't get ignore-path-error to ignore D000, so ignoring files
+ignore-path=doc/_build
+extension=.rst
 
 # vim: wrap sts=2 sw=2