From 30c1cec25eff0a37ad494f57bfc8fce7dedf5de2 Mon Sep 17 00:00:00 2001
From: Nat Williams <nwilliams@leapfrogonline.com>
Date: Mon, 16 Apr 2012 15:39:27 -0500
Subject: add docs and a few little pep8 tweaks

---
 docs/git_data.rst | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/services.rst |  1 +
 2 files changed, 87 insertions(+)
 create mode 100644 docs/git_data.rst

(limited to 'docs')

diff --git a/docs/git_data.rst b/docs/git_data.rst
new file mode 100644
index 0000000..549420b
--- /dev/null
+++ b/docs/git_data.rst
@@ -0,0 +1,86 @@
+.. _Git Data service:
+
+Git Data services
+=================
+
+**Example**::
+
+  from pygithub3 import Github
+
+  gh = Github(user='someone', repo='some_repo')
+
+  a_blob = gh.git_data.blobs.get('a long sha')
+
+  dev_branch = gh.git_data.references.get('heads/add_a_thing')
+
+
+GitData
+-------
+
+.. autoclass:: pygithub3.services.git_data.GitData
+    :members:
+
+    .. attribute:: blobs
+
+        :ref:`Blobs service`
+
+    .. attribute:: commits
+
+        :ref:`Commits service`
+
+    .. attribute:: references
+
+        :ref:`References service`
+
+    .. attribute:: tags
+
+        :ref:`Tags service`
+
+    .. attribute:: trees
+
+        :ref:`Trees service`
+
+
+.. _Blobs service:
+
+Blobs
+-----
+
+.. autoclass:: pygithub3.services.git_data.Blobs
+    :members:
+
+
+.. _Commits service:
+
+Commits
+-------
+
+.. autoclass:: pygithub3.services.git_data.Commits
+    :members:
+
+
+.. _References service:
+
+References
+----------
+
+.. autoclass:: pygithub3.services.git_data.References
+    :members:
+
+
+.. _Tags service:
+
+Tags
+----
+
+.. autoclass:: pygithub3.services.git_data.Tags
+    :members:
+
+
+.. _Trees service:
+
+Trees
+-----
+
+.. autoclass:: pygithub3.services.git_data.Trees
+    :members:
diff --git a/docs/services.rst b/docs/services.rst
index 71fa690..2fbd2ee 100644
--- a/docs/services.rst
+++ b/docs/services.rst
@@ -72,5 +72,6 @@ List of services
     users
     repos
     gists
+    git_data
 
 .. _mimetypes: http://developer.github.com/v3/mime
-- 
cgit v1.2.3-59-g8ed1b


From 9517cf574615ba9b18fe9f0807b1f1f6cc540357 Mon Sep 17 00:00:00 2001
From: Nat Williams <nwilliams@leapfrogonline.com>
Date: Mon, 16 Apr 2012 16:05:51 -0500
Subject: add test_requirements.txt and more test running instructions

---
 README.rst            |  8 ++++++--
 docs/installation.rst | 14 ++++++++++----
 test_requirements.txt |  4 ++++
 3 files changed, 20 insertions(+), 6 deletions(-)
 create mode 100644 test_requirements.txt

(limited to 'docs')

diff --git a/README.rst b/README.rst
index d37650b..cc787d8 100644
--- a/README.rst
+++ b/README.rst
@@ -58,5 +58,9 @@ Contribute
 4. Add you to ``AUTHORS``
 5. Pull request it
 
-**Note**: I use `nose <http://readthedocs.org/docs/nose/en/latest/>`_ test environment,
-with `mock <http://www.voidspace.org.uk/python/mock/>`_ ``pip install nose mock``
+Tests
+-----
+
+Test and docs requirements are listed in ``test_requirements.txt``.
+Run ``pip install -r test_requirements.txt`` to install them and ``nosetests``
+to run tests
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/
diff --git a/test_requirements.txt b/test_requirements.txt
new file mode 100644
index 0000000..862d240
--- /dev/null
+++ b/test_requirements.txt
@@ -0,0 +1,4 @@
+nose
+unittest2
+mock
+sphinx
-- 
cgit v1.2.3-59-g8ed1b