From 7ec9da923f4e918c7799b81810cceca64d36f967 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Wed, 13 Jul 2016 12:58:04 +0100 Subject: [PATCH] Implement doc8 checks for docs In order to prepare for the move of detailed configuration content from the install guide to the roles, doc8 checks are being implemented in the roles to ensure that any new content submitted is properly checked. Change-Id: Ie2f93228d701eee9e6168173b319f2557d7f7c3d Partially-Implements: blueprint osa-install-guide-overhaul --- test-requirements.txt | 3 ++- tox.ini | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/test-requirements.txt b/test-requirements.txt index c1b238a..ec7ec49 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,4 +4,5 @@ flake8>=2.5.4,<2.6.0 # MIT # this is required for the docs build jobs sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0 -reno>=1.6.2 # Apache-2.0 +doc8 # Apache-2.0 +reno>=1.6.2 # Apache-2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 76a7722..e2607e8 100644 --- a/tox.ini +++ b/tox.ini @@ -32,9 +32,15 @@ setenv = [testenv:docs] commands= bash -c "rm -rf doc/build" + doc8 doc python setup.py build_sphinx +[doc8] +# Settings for doc8: +extensions = .rst + + [testenv:releasenotes] # NOTE(sdague): this target does not use constraints because # upstream infra does not yet support it. Once that's fixed, we can