Merged pull request #3 from natw/git_data

3 files changed, 97 insertions, 4 deletions

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/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/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