aboutsummaryrefslogtreecommitdiffstats
path: root/docs/orgs.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/orgs.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/orgs.rst b/docs/orgs.rst
new file mode 100644
index 0000000..96e7a73
--- /dev/null
+++ b/docs/orgs.rst
@@ -0,0 +1,46 @@
+.. _Orgs service:
+
+Orgs services
+==============
+
+**Fast sample**::
+
+ from pygithub3 import Github
+
+ gh = Github(token='abc123')
+
+ auth_orgs = gh.orgs.list().all()
+ members = gh.orgs.members.list('github')
+
+Org
+------
+
+.. autoclass:: pygithub3.services.orgs.Org
+ :members:
+
+ .. attribute:: members
+
+ :ref:`Members service`
+
+ .. attribute:: teams
+
+ :ref:`Teams service`
+
+.. _Members service:
+
+Members
+---------
+
+.. autoclass:: pygithub3.services.orgs.members.Members
+ :members:
+
+.. _Teams service:
+
+Teams
+-------
+
+.. autoclass:: pygithub3.services.orgs.teams.Teams
+ :members:
+
+.. _github orgs doc: http://developer.github.com/v3/orgs
+.. _github orgs teams doc: http://developer.github.com/v3/orgs/teams