diff options
| author |   David Medina <davidmedina9@gmail.com> | 2012-06-16 13:56:29 +0200 |
|---|---|---|
| committer | David Medina <davidmedina9@gmail.com> | 2012-06-16 13:58:12 +0200 |
| commit | 107b12b3b48040488ff6ddd54cb1300200dc8b37 (patch) | |
| tree | f35c57bb8b5c5cd85511aaad1c0df0e4f97c0c25 /docs | |
| parent | Merge #5 'services/orgs' (diff) | |
| parent | Tests on services.issues working (diff) | |
| download | python-github3-107b12b3b48040488ff6ddd54cb1300200dc8b37.tar.xz python-github3-107b12b3b48040488ff6ddd54cb1300200dc8b37.zip | |
Merge #12 'services/issues'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/issues.rst | 74 | ||||
| -rw-r--r-- | docs/services.rst | 1 |
2 files changed, 75 insertions, 0 deletions
diff --git a/docs/issues.rst b/docs/issues.rst new file mode 100644 index 0000000..708d363 --- /dev/null +++ b/docs/issues.rst @@ -0,0 +1,74 @@ +.. _Issues service: + +Issues services +=============== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + octocat_issues = gh.issues.list() + octocat_repo_issues = gh.issues.list_by_repo('octocat', 'Hello-World') + +Issues +------ + +.. autoclass:: pygithub3.services.issues.Issue + :members: + + .. attribute:: comments + + :ref:`Comments service` + + .. attribute:: events + + :ref:`Events service` + + .. attribute:: labels + + :ref:`Labels service` + + .. attribute:: milestones + + :ref:`Milestones service` + +.. _Comments service: + +Comments +-------- + +.. autoclass:: pygithub3.services.issues.Comments + :members: + +.. _Events service: + +Events +------ + +.. autoclass:: pygithub3.services.issues.Events + :members: + +.. _Labels service: + +Labels +------ + +.. autoclass:: pygithub3.services.issues.Labels + :members: + +.. _Milestones service: + +Milestones +---------- + +.. autoclass:: pygithub3.services.issues.Milestones + :members: + +.. _github issues doc: http://developer.github.com/v3/issues +.. _github comments doc: http://developer.github.com/v3/issues/comments +.. _github events doc: http://developer.github.com/v3/issues/events +.. _github labels doc: http://developer.github.com/v3/issues/labels +.. _github milestones doc: http://developer.github.com/v3/issues/milestones diff --git a/docs/services.rst b/docs/services.rst index f7de042..7152aca 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -75,5 +75,6 @@ List of services git_data pull_requests orgs + issues .. _mimetypes: http://developer.github.com/v3/mime |