diff --git a/test-requirements.txt b/test-requirements.txt index 13ccbae..d102bc2 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,3 +7,4 @@ hacking<0.11,>=0.10.2 # Apache-2.0 Babel!=2.4.0,>=2.3.4 # BSD sphinx>=1.6.2 # BSD openstackdocstheme>=1.16.0 # Apache-2.0 +doc8 # Apache-2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 8358057..35dce2d 100644 --- a/tox.ini +++ b/tox.ini @@ -20,6 +20,7 @@ passenv = # Pass NO_LANG_BUILD=1 if you would like to build English version only NO_LANG_BUILD commands = + doc8 doc/source # Build translated guides {toxinidir}/tools/build-docs.sh # Publish @@ -45,3 +46,14 @@ commands = {toxinidir}/tools/generatepot.sh [testenv:zanata-users-sync] commands = python {toxinidir}/tools/zanata/zanata_users.py --output-file {toxinidir}/tools/zanata/translation_team.yaml + +[doc8] +# File extensions to check +extensions = .rst, .yaml +# Maximal line length should be 80 but we have some overlong lines. +# Let's not get far more in. +max-line-length = 80 +# Disable some doc8 checks: +# D000: Check RST validity +# - cannot handle "none" for code-block directive +ignore = D000