summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorDarragh Bailey <dbailey@hpe.com>2015-12-09 13:12:47 +0000
committerDarragh Bailey <dbailey@hpe.com>2016-01-11 13:06:17 +0000
commit3faecfd76a953477b236333738892d3db23252f1 (patch)
treeb44482dae04906409e398e2f02de4840951b8234 /tox.ini
parent84091b384e366cfff6e84b70590a9784ce13033c (diff)
downloadpython-jenkins-job-builder-3faecfd76a953477b236333738892d3db23252f1.tar.gz
python-jenkins-job-builder-3faecfd76a953477b236333738892d3db23252f1.tar.xz
python-jenkins-job-builder-3faecfd76a953477b236333738892d3db23252f1.zip
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
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini5
1 files changed, 4 insertions, 1 deletions
diff --git a/tox.ini b/tox.ini
index 99ee9e40..be1a887c 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}