diff options
| author |   Sylvain Desbureaux <sylvain.desbureaux@orange.com> | 2020-12-09 10:13:42 +0100 |
|---|---|---|
| committer | Sylvain Desbureaux <sylvain.desbureaux@orange.com> | 2021-01-20 09:51:24 +0100 |
| commit | 090941b572c917d8e84ea709eb3696fdc8f53be1 (patch) | |
| tree | c88f912d2f4fa33a27b6bfad8b9042d23df0d96a /tox.ini | |
| parent | a9cdb59bd9907399984b9a4ee6bef792bfa9356f (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
(cherry picked from commit ec07bca720e5e2156be085e89f1ce8521a602eaf)
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 19 |
1 files changed, 19 insertions, 0 deletions
@@ -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 -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + +[testenv:docs-linkcheck] +deps = -rdocs/requirements-docs.txt +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + [testenv:gitlint] basepython = python3 deps = |