aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-01 19:41:46 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-01 19:43:26 +0100
commit5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8 (patch)
treec90ab9489c5217151c1f1c716aea8fa39b303393 /docs
parentWIP on services.repos doc (diff)
downloadpython-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.tar.xz
python-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.zip
Complete services.repos doc
Also add Mimetypes doc
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst2
-rw-r--r--docs/repos.rst21
-rw-r--r--docs/result.rst28
-rw-r--r--docs/services.rst9
4 files changed, 23 insertions, 37 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 24561ca..71f377c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -38,7 +38,7 @@ You must apologize my English level. I'm trying to do my best
installation
github
services
- resources
result
+ resources
.. _Github API v3 documentation: http://developer.github.com
diff --git a/docs/repos.rst b/docs/repos.rst
index f42796f..2b58f32 100644
--- a/docs/repos.rst
+++ b/docs/repos.rst
@@ -22,7 +22,8 @@ Some request always need ``user`` and ``repo`` parameters, both, to identify
a `repository`. Because there are a lot of requests which need that parameters,
you can :ref:`config each service` with ``user`` and ``repo`` globally.
-So several requests follow a simple precedence ``user_in_arg > user_in_config``
+So several requests follow a simple precedence
+``user_in_arg > user_in_config | repo_in_arg > repo_in_config``
You can see it better with an example: ::
@@ -127,10 +128,16 @@ Watchers
.. autoclass:: pygithub3.services.repos.Watchers
:members:
+.. _Hooks service:
+
+Hooks
+---------
+
.. _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
+.. _github collaborators doc: http://developer.github.com/v3/repos/collaborators
+.. _github commits doc: http://developer.github.com/v3/repos/commits
+.. _github downloads doc: http://developer.github.com/v3/repos/downloads
+.. _github forks doc: http://developer.github.com/v3/repos/forks
+.. _github keys doc: http://developer.github.com/v3/repos/keys
+.. _github watching doc: http://developer.github.com/v3/repos/watching
+.. _github hooks doc: http://developer.github.com/v3/repos/hooks
diff --git a/docs/result.rst b/docs/result.rst
index 2162745..f084807 100644
--- a/docs/result.rst
+++ b/docs/result.rst
@@ -7,31 +7,3 @@ Some requests returns multiple :doc:`resources`, for that reason the
.. autoclass:: pygithub3.core.result.Result
-You have several ways to consume it
-
-1. Iterating over the result::
-
- result = some_request()
- for page in result:
- for resource in page:
- print resource
-
-2. With a generator::
-
- result = some_request()
- for resource in result.iterator():
- print resource
-
-3. As a list::
-
- result = some_request()
- print result.all()
-
-4. Also you can request some page manually
-
-.. autoattribute:: pygithub3.core.result.Result.pages
-.. automethod:: pygithub3.core.result.Result.get_page
-
-Each ``Page`` is an iterator and contains resources
-
-
diff --git a/docs/services.rst b/docs/services.rst
index 7dfec34..a0fd894 100644
--- a/docs/services.rst
+++ b/docs/services.rst
@@ -40,11 +40,16 @@ service has her client which is configurated with this variables).
.. autoclass:: pygithub3.services.base.Service
:members:
-.. _mimetypes:
+.. _mimetypes-section:
MimeTypes
----------
+Some services supports `mimetypes`_
+
+With them the :doc:`resources` will have ``body``, ``body_text``, ``body_html``
+attributes or all of them.
+
.. autoclass:: pygithub3.services.base.MimeTypeMixin
:members:
@@ -56,3 +61,5 @@ List of services
users
repos
+
+.. _mimetypes: http://developer.github.com/v3/mime