diff options
| author |   Nat Williams <nwilliams@leapfrogonline.com> | 2012-04-16 16:05:51 -0500 |
|---|---|---|
| committer | Nat Williams <nwilliams@leapfrogonline.com> | 2012-04-16 16:05:51 -0500 |
| commit | 9517cf574615ba9b18fe9f0807b1f1f6cc540357 (patch) | |
| tree | 44a33954fbd282a1a54ebf1e5d3e53e2513d3760 /docs | |
| parent | add docs and a few little pep8 tweaks (diff) | |
| download | python-github3-9517cf574615ba9b18fe9f0807b1f1f6cc540357.tar.xz python-github3-9517cf574615ba9b18fe9f0807b1f1f6cc540357.zip | |
add test_requirements.txt and more test running instructions
Diffstat (limited to 'docs')
| -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/ |