diff options
author | 2012-04-16 15:39:27 -0500 | |
---|---|---|
committer | 2012-04-16 15:39:27 -0500 | |
commit | 30c1cec25eff0a37ad494f57bfc8fce7dedf5de2 (patch) | |
tree | 7e45d97961ec773c4df4fe0ab5d7eb4e0431f725 /docs/git_data.rst | |
parent | def != class (diff) | |
download | python-github3-30c1cec25eff0a37ad494f57bfc8fce7dedf5de2.tar.xz python-github3-30c1cec25eff0a37ad494f57bfc8fce7dedf5de2.zip |
add docs and a few little pep8 tweaks
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: |