From 3e065e97e314e5d42fd9d0094e640c10df03595d Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Wed, 28 Sep 2016 12:21:11 +0100 Subject: [PATCH] Implement doc8 checks Change-Id: Ic830833f6abef29a5fc5ca13500a9a8d9a7c036d --- requirements.txt | 1 + tox.ini | 19 +++++++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/requirements.txt b/requirements.txt index 5e124f4..9e4a6b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,3 +5,4 @@ # this is required for the docs build jobs sphinx!=1.3b1,<1.3,>=1.2.1 # BSD oslosphinx>=4.7.0 # Apache-2.0 +doc8 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 2236f5a..6bfb2fd 100644 --- a/tox.ini +++ b/tox.ini @@ -23,16 +23,23 @@ passenv = whitelist_externals = bash setenv = + PYTHONUNBUFFERED=1 VIRTUAL_ENV={envdir} +[testenv:docs] +commands= + bash -c "rm -rf doc/build" + doc8 doc + python setup.py build_sphinx + + +[doc8] +# Settings for doc8: +extensions = .rst + + # environment used by the -infra templated docs job [testenv:venv] commands = {posargs} - - -[testenv:docs] -commands= - bash -c "rm -rf doc/build" - python setup.py build_sphinx