From 3faecfd76a953477b236333738892d3db23252f1 Mon Sep 17 00:00:00 2001 From: Darragh Bailey Date: Wed, 9 Dec 2015 13:12:47 +0000 Subject: [PATCH] Add separate linkcheck env and allow dev to select builder Add separate linkcheck tox environment to be used in non-voting Jenkins job to watch for stale and broken links in the sphinx generated html documentation. Include a small addition to make it easier for contributors to select individual builders when executing the docs tox environment. Add minimum dependency of pbr 1.0.0, as that was the first version to allow passing of sphinx builders on the command line to override the internal defaults or those set in the configuration file. This will make it easier to spot problems with just the links, and also ensure that when the sphinx project releases with proper warniserror fix for the linkcheck builder, that html and man page documentation can continue to be built even if a previous valid link has become stale or is temporarily unreachable. Change-Id: I80446abe96824a444a04cc526df6cc38632a4607 --- requirements.txt | 2 +- tox.ini | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index b4be8c00c..ae6c212de 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ ordereddict six>=1.5.2 PyYAML python-jenkins>=0.4.8 -pbr>=0.8.2,<2.0 +pbr>=1.0.0,<2.0 diff --git a/tox.ini b/tox.ini index 99ee9e40a..be1a887c6 100644 --- a/tox.ini +++ b/tox.ini @@ -33,7 +33,10 @@ commands = jenkins-jobs test -o .test/old/out/ .test/old/config/ commands = jenkins-jobs test -o .test/new/out/ .test/new/config/ [testenv:docs] -commands = python setup.py build_sphinx +commands = python setup.py build_sphinx {posargs} + +[testenv:docs-linkcheck] +commands = python setup.py build_sphinx -b linkcheck [testenv:venv] commands = {posargs}