aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-01 14:10:48 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-01 14:10:48 +0100
commit614ed5b2acf916b71803532e499df9068b6273bd (patch)
tree9e5ed8fa41c824047e73ca7a1ede33e3e66941f2 /docs
parentRestructure modules and packages in a clean way (diff)
downloadpython-github3-614ed5b2acf916b71803532e499df9068b6273bd.tar.xz
python-github3-614ed5b2acf916b71803532e499df9068b6273bd.zip
WIP on services.repos doc
+services.repos.collaborators doc +services.repos.commits doc
Diffstat (limited to 'docs')
-rw-r--r--docs/repos.rst14
-rw-r--r--docs/services.rst14
2 files changed, 24 insertions, 4 deletions
diff --git a/docs/repos.rst b/docs/repos.rst
index 2a5bbe2..f42796f 100644
--- a/docs/repos.rst
+++ b/docs/repos.rst
@@ -82,6 +82,7 @@ Collaborators
--------------
.. autoclass:: pygithub3.services.repos.Collaborators
+ :members:
.. _Commits service:
@@ -89,6 +90,7 @@ Commits
----------
.. autoclass:: pygithub3.services.repos.Commits
+ :members:
.. _Downloads service:
@@ -96,6 +98,7 @@ Downloads
------------
.. autoclass:: pygithub3.services.repos.Downloads
+ :members:
.. _Forks service:
@@ -104,6 +107,7 @@ Forks
---------
.. autoclass:: pygithub3.services.repos.Forks
+ :members:
.. _RepoKeys service:
@@ -112,6 +116,7 @@ Keys
----------
.. autoclass:: pygithub3.services.repos.Keys
+ :members:
.. _Watchers service:
@@ -120,5 +125,12 @@ Watchers
---------
.. autoclass:: pygithub3.services.repos.Watchers
+ :members:
-.. _github repo doc: http://developer.github.com/v3/repos
+.. _github repos doc: http://developer.github.com/v3/repos
+.. _github collaborators doc: http://developer.github.com/v3/repos
+.. _github commits doc: http://developer.github.com/v3/repos
+.. _github downloads doc: http://developer.github.com/v3/repos
+.. _github forks doc: http://developer.github.com/v3/repos
+.. _github watching doc: http://developer.github.com/v3/repos
+.. _github hooks doc: http://developer.github.com/v3/repos
diff --git a/docs/services.rst b/docs/services.rst
index 8611455..7dfec34 100644
--- a/docs/services.rst
+++ b/docs/services.rst
@@ -5,7 +5,7 @@ Services
start
Overview
-..........
+----------
You can access to the API requests through the different services.
@@ -28,7 +28,7 @@ from the rest**.
.. _config each service:
Config each service
-.....................................
+----------------------
Each service can be configurated with some variables (behind the scenes, each
service has her client which is configurated with this variables).
@@ -40,8 +40,16 @@ service has her client which is configurated with this variables).
.. autoclass:: pygithub3.services.base.Service
:members:
+.. _mimetypes:
+
+MimeTypes
+----------
+
+.. autoclass:: pygithub3.services.base.MimeTypeMixin
+ :members:
+
List of services
-..................
+-------------------
.. toctree::
:maxdepth: 2