diff options
author | Darragh Bailey <dbailey@hpe.com> | 2016-01-21 19:40:26 +0000 |
---|---|---|
committer | Darragh Bailey <dbailey@hpe.com> | 2016-09-15 11:33:35 +0100 |
commit | e165b78546aa094dcf81931aacb778a2277b4034 (patch) | |
tree | 0eb5229e2e00de5d30c6162e1238e4df991d0991 /README.rst | |
parent | e1de6f22ffa444a28381701dbb800b1b39de0892 (diff) | |
download | python-jenkins-job-builder-e165b78546aa094dcf81931aacb778a2277b4034.tar.gz python-jenkins-job-builder-e165b78546aa094dcf81931aacb778a2277b4034.tar.xz python-jenkins-job-builder-e165b78546aa094dcf81931aacb778a2277b4034.zip |
Add comment about proxy env pass through
For users in a proxy environment, checking the doc urls requires being
able to pass through the proxy environment variables. Include a simple
comment along with the tox command requiring it to help users checking
any links added are valid.
Add some references to documentation, both in the detailed
documentation and the quick README.rst that would be more commonly
checked.
Change-Id: I2316bc1b7e845c29a8b248eef4668a6099d109f7
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -69,6 +69,21 @@ This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation. +Unit Tests +---------- + +Unit tests have been included and are in the ``tests`` folder. Many unit +tests samples are included as examples in our documentation to ensure that +examples are kept current with existing behaviour. To run the unit tests, +execute the command:: + + tox -e py34,py27 + +* Note: View ``tox.ini`` to run tests on other versions of Python, + generating the documentation and additionally for any special notes + on running the test to validate documentation external URLs from behind + proxies. + Installing without setup.py --------------------------- |