diff options
| author | 2012-04-17 18:45:46 +0200 | |
|---|---|---|
| committer | 2012-04-17 18:45:46 +0200 | |
| commit | 8430f64e6f0025b3d3d088ffd13c50b7123972f6 (patch) | |
| tree | 214726395e1f0108e757a47d2c0de0ec36a3aeb5 /docs/git_data.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/git_data.rst')
| -rw-r--r-- | docs/git_data.rst | 86 |
1 files changed, 86 insertions, 0 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: |
