summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorSylvain Desbureaux <sylvain.desbureaux@orange.com>2020-12-09 10:13:42 +0100
committerSylvain Desbureaux <sylvain.desbureaux@orange.com>2020-12-09 10:13:42 +0100
commitec07bca720e5e2156be085e89f1ce8521a602eaf (patch)
tree851fb4de36e2875902eb2d182484e8ef27490876 /tox.ini
parent208c952967efcd791eb0ffc5432c92284bc5c881 (diff)
[COMMON] Add doc linting
Add 3 automated doc linting (sphinx building, linkchecking and doc8) in order to have an error free documentations Fix also issues found by these linters in order to start without errors. Issue-ID: OOM-2648 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I318718c956020412a120ba3caeb9e21d35a99833
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini19
1 files changed, 19 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
index 60f93a35e4..fa189761d4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,9 +1,28 @@
[tox]
minversion = 1.6
envlist =
+ docs,
+ docs-linkcheck,
gitlint,
skipsdist=true
+[doc8]
+ignore-path-errors=docs/helm-search.txt;D001
+
+[testenv:doc8]
+deps = -rdocs/requirements-docs.txt
+commands =
+ doc8 docs/
+
+[testenv:docs]
+deps = -rdocs/requirements-docs.txt
+commands =
+ sphinx-build -j auto -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements-docs.txt
+commands = sphinx-build -j auto -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
[testenv:gitlint]
basepython = python3
deps =