diff options
| author |   David Medina <davidmedina9@gmail.com> | 2012-04-17 18:45:46 +0200 |
|---|---|---|
| committer | David Medina <davidmedina9@gmail.com> | 2012-04-17 18:45:46 +0200 |
| commit | 8430f64e6f0025b3d3d088ffd13c50b7123972f6 (patch) | |
| tree | 214726395e1f0108e757a47d2c0de0ec36a3aeb5 /docs/installation.rst | |
| parent | :sparkles: Release 0.3 :sparkles: (diff) | |
| parent | add myself to AUTHORS and some other docs tweaks (diff) | |
| download | python-github3-8430f64e6f0025b3d3d088ffd13c50b7123972f6.tar.xz python-github3-8430f64e6f0025b3d3d088ffd13c50b7123972f6.zip | |
Merged pull request #3 from natw/git_data
Diffstat (limited to 'docs/installation.rst')
| -rw-r--r-- | docs/installation.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 8ed6c10..6eccc95 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -15,15 +15,21 @@ Dependencies Required ......... -This library only depends on `request library`_ module. +This library depends only on the `requests`_ module. -If you install ``pygithub3`` with ``pip`` all is done. The best option +If you install ``pygithub3`` with ``pip`` all is done. This is the best option. Optional ......... -If you want to run the test suite, you must install `nose`_ and `mock`_ +The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the +documentation requires `sphinx`_. -.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html +Install all of these by running ``pip install -r test_requirements.txt``. Then +just run ``nosetests`` to run the tests. + +.. _requests: http://docs.python-requests.org/en/v0.10.6/index.html .. _nose: http://readthedocs.org/docs/nose/en/latest .. _mock: http://pypi.python.org/pypi/mock +.. _unittest2: http://pypi.python.org/pypi/unittest2 +.. _sphinx: http://sphinx.pocoo.org/ |