diff options
| author | Jenkins <jenkins@review.openstack.org> | 2016-09-29 17:01:52 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2016-09-29 17:01:52 +0000 |
| commit | fcf2d9860ba557e56d181a3dd4497f5d200224e4 (patch) | |
| tree | b4aabe5ef205d4e10270759e6bf0dd5a77eaadad /doc/source | |
| parent | 0ece25ced476be0d898bc4f0f5197025239494ee (diff) | |
| parent | e165b78546aa094dcf81931aacb778a2277b4034 (diff) | |
| download | python-jenkins-job-builder-fcf2d9860ba557e56d181a3dd4497f5d200224e4.tar.gz python-jenkins-job-builder-fcf2d9860ba557e56d181a3dd4497f5d200224e4.tar.xz python-jenkins-job-builder-fcf2d9860ba557e56d181a3dd4497f5d200224e4.zip | |
Merge "Add comment about proxy env pass through"
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/installation.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 9187451e..ddd4a5b6 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -33,6 +33,15 @@ locally execute the command:: The generated documentation is then available under ``doc/build/html/index.html``. +As over time URLs change or become stale there is also a testenv available +to verify any links added. To run locally execute the command:: + + tox -e docs-linkcheck + +* Note: When behind a proxy it is necessary to use ``TOX_TESTENV_PASSENV`` + to pass any proxy settings for this test to be able to check links are + valid. + Unit Tests ---------- |