Uses doc8 check
doc8 is a linter for documents and used in Docs team. Let's enforce the linter for better writing of I18n contributor guide. (The rules are the same in I3810df521068ffc97e25a5fc56b72397bf9783bc) Change-Id: Ib7662e6ea8095b371074e6404dbb179e89a00a94
This commit is contained in:
parent
b96b08f8ca
commit
572fcb052c
|
@ -7,3 +7,4 @@ hacking<0.11,>=0.10.2 # Apache-2.0
|
||||||
Babel!=2.4.0,>=2.3.4 # BSD
|
Babel!=2.4.0,>=2.3.4 # BSD
|
||||||
sphinx>=1.6.2 # BSD
|
sphinx>=1.6.2 # BSD
|
||||||
openstackdocstheme>=1.16.0 # Apache-2.0
|
openstackdocstheme>=1.16.0 # Apache-2.0
|
||||||
|
doc8 # Apache-2.0
|
12
tox.ini
12
tox.ini
|
@ -20,6 +20,7 @@ passenv =
|
||||||
# Pass NO_LANG_BUILD=1 if you would like to build English version only
|
# Pass NO_LANG_BUILD=1 if you would like to build English version only
|
||||||
NO_LANG_BUILD
|
NO_LANG_BUILD
|
||||||
commands =
|
commands =
|
||||||
|
doc8 doc/source
|
||||||
# Build translated guides
|
# Build translated guides
|
||||||
{toxinidir}/tools/build-docs.sh
|
{toxinidir}/tools/build-docs.sh
|
||||||
# Publish
|
# Publish
|
||||||
|
@ -45,3 +46,14 @@ commands = {toxinidir}/tools/generatepot.sh
|
||||||
[testenv:zanata-users-sync]
|
[testenv:zanata-users-sync]
|
||||||
commands =
|
commands =
|
||||||
python {toxinidir}/tools/zanata/zanata_users.py --output-file {toxinidir}/tools/zanata/translation_team.yaml
|
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
|
||||||
|
|
Loading…
Reference in New Issue