summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-04-22 20:20:26 +0000
committerGerrit Code Review <review@openstack.org>2014-04-22 20:20:26 +0000
commitb92103607feea07e79269025b136fdd1fc913bf8 (patch)
tree6d95bb6e29d4db7663449a0bc47bf802a31b6acf /README.rst
parentabbf318c4dcb8f0e17f38ceeaa9c2f5fa63f2611 (diff)
parent288938ab72bc4d17d5d818fcbe45cd8cb03ae2e1 (diff)
downloadpython-jenkins-job-builder-b92103607feea07e79269025b136fdd1fc913bf8.tar.gz
python-jenkins-job-builder-b92103607feea07e79269025b136fdd1fc913bf8.tar.xz
python-jenkins-job-builder-b92103607feea07e79269025b136fdd1fc913bf8.zip
Merge "README.rst: Add links"
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 103d3fe0..03e12acc 100644
--- a/README.rst
+++ b/README.rst
@@ -39,9 +39,9 @@ More details on how you can contribute is available on our wiki at:
Writing a patch
===============
-We ask that all code submissions be pep8 and pyflakes clean. The
-easiest way to do that is to run `tox` before submitting code for
-review in Gerrit. It will run `pep8` and `pyflakes` in the same
+We ask that all code submissions be pep8_ and pyflakes_ clean. The
+easiest way to do that is to run tox_ before submitting code for
+review in Gerrit. It will run ``pep8`` and ``pyflakes`` in the same
manner as the automated test suite that will run on proposed
patchsets.
@@ -62,12 +62,18 @@ implementation.
Installing without setup.py
===========================
-For YAML support, you will need libyaml installed.
+For YAML support, you will need libyaml_ installed.
Mac OS X::
$ brew install libyaml
-Then install the required python packages using pip::
+Then install the required python packages using pip_::
$ sudo pip install PyYAML python-jenkins
+
+.. _pep8: https://pypi.python.org/pypi/pep8
+.. _pyflakes: https://pypi.python.org/pypi/pyflakes
+.. _tox: https://testrun.org/tox
+.. _libyaml: http://pyyaml.org/wiki/LibYAML
+.. _pip: https://pypi.python.org/pypi/pip