diff options
| author |   David Medina <davidmedina9@gmail.com> | 2012-04-03 23:18:52 +0200 |
|---|---|---|
| committer | David Medina <davidmedina9@gmail.com> | 2012-04-03 23:18:52 +0200 |
| commit | 37e871617148bfde801a499699bbf2205125d830 (patch) | |
| tree | c38c9fded3b56554d2a22fe1f7712dab9be6dca9 /docs | |
| parent | Fix naming (diff) | |
| download | python-github3-37e871617148bfde801a499699bbf2205125d830.tar.xz python-github3-37e871617148bfde801a499699bbf2205125d830.zip | |
Gists services doc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gists.rst | 37 | ||||
| -rw-r--r-- | docs/services.rst | 1 |
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/gists.rst b/docs/gists.rst new file mode 100644 index 0000000..3b2915f --- /dev/null +++ b/docs/gists.rst @@ -0,0 +1,37 @@ +.. _Gists service: + +Gists services +=============== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + octocat_gists = gh.gists.list() + the_first_gist = gh.gists.get(1) + + the_first_gist_comments = gh.gists.comments.list(1) + +Gist +----- + +.. autoclass:: pygithub3.services.gists.Gist + :members: + + .. attribute:: comments + + :ref:`Comments service` + +.. _Comments service: + +Comments +---------- + +.. autoclass:: pygithub3.services.gists.Comments + :members: + +.. _github gists doc: http://developer.github.com/v3/gists +.. _github comments doc: http://developer.github.com/v3/gists/comments diff --git a/docs/services.rst b/docs/services.rst index a0fd894..e686a6e 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -61,5 +61,6 @@ List of services users repos + gists .. _mimetypes: http://developer.github.com/v3/mime |