Skip to content

Commit 41de1bb

Browse files
committed
Use pypi role to refer to packages in docs.
1 parent f2f0cdf commit 41de1bb

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

doc/contributing.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Tests
3232
Unfortunately there aren't many tests for ``python-github`` at the moment,
3333
any patches to increase test coverage are greatly appreciated
3434

35-
The preferred way to run the package's tests is with nose_. ``nosetests``
36-
provides excellent reporting options and its additional features make it
37-
invaluable, see the nose_ documentation for usage information.
35+
The preferred way to run the package's tests is with :pypi:`nose`.
36+
``nosetests`` provides excellent reporting options and its additional features
37+
make it invaluable, see the nose_ documentation for usage information.
3838

39-
There is a tox_ configuration file included in the repository, you can use it to
40-
run the tests against multiple Python versions with a single command. The
41-
configuration file also includes targets for testing the documentation. The
39+
There is a :pypi:`tox` configuration file included in the repository, you can
40+
use it to run the tests against multiple Python versions with a single command.
41+
The configuration file also includes targets for testing the documentation. The
4242
tox_ documentation includes a fantastic number of examples on how to use it, and
4343
advice on adding new testing targets.
4444

doc/install.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Installation
44
You can install :mod:`github2` either via the Python Package Index (PyPI) or
55
from source.
66

7-
To install using ``pip``::
7+
To install using :pypi:`pip`::
88

99
$ pip install github2 # to install in Python's site-packages
1010
$ pip install --install-option="--user" github2 # to install for a single user
1111

12-
To install using ``easy_install``::
12+
To install using :pypi:`easy_install <setuptools>`::
1313

1414
$ easy_install github2
1515

@@ -20,8 +20,9 @@ following::
2020
# python setup.py install # to install in Python's site-packages
2121
$ python setup.py install --user # to install for a single user
2222

23-
:mod:`github2` depends on :pypi:`httplib2`, an excellent package by Joe
24-
Gregorio for handling HTTP sessions. :pypi:`simplejson` is also required when
25-
using :mod:`github2` with Python 2.4 or 2.5. If you install via ``pip`` or
26-
``easy_install`` the dependencies should be installed automatically for you.
27-
:pypi:`SocksiPy-branch` is an optional dependency if proxy support is needed.
23+
:mod:`github2` depends on :pypi:`httplib2`, an excellent package by Joe Gregorio
24+
for handling HTTP sessions. :pypi:`simplejson` is also required when using
25+
:mod:`github2` with Python 2.4 or 2.5. If you install via :pypi:`pip` or
26+
:pypi:`easy_install <setuptools>` the dependencies should be installed
27+
automatically for you. :pypi:`SocksiPy-branch` is an optional dependency if
28+
proxy support is needed.

0 commit comments

Comments
 (0)