From: amercader <amercadero@gmail.com>
Date: Tue, 30 Apr 2013 14:15:56 +0000 (+0200)
Subject: Fix API documentation issues
X-Git-Tag: v1.2.1~2^2~8^2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=505d2487e31c2ac60ed9224b82441320d3af5077;p=services%2Fpython-requests.git

Fix API documentation issues

* 'Cookies' and 'Encodings' sections were not built because the
  reference to the functions was wrong.
* 'Exceptions' section had a wrong anchor link ('module-requests', same
   one as the main heading).
* Remove 'decode_gzip' function, which is no longer present.
---

diff --git a/docs/api.rst b/docs/api.rst
index cf68ca4..08cb1b8 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -48,13 +48,11 @@ Request Sessions
 Exceptions
 ~~~~~~~~~~
 
-.. module:: requests
-
-.. autoexception:: RequestException
-.. autoexception:: ConnectionError
-.. autoexception:: HTTPError
-.. autoexception:: URLRequired
-.. autoexception:: TooManyRedirects
+.. autoexception:: requests.exceptions.RequestException
+.. autoexception:: requests.exceptions.ConnectionError
+.. autoexception:: requests.exceptions.HTTPError
+.. autoexception:: requests.exceptions.URLRequired
+.. autoexception:: requests.exceptions.TooManyRedirects
 
 
 Status Code Lookup
@@ -76,18 +74,17 @@ Status Code Lookup
 Cookies
 ~~~~~~~
 
-.. autofunction:: dict_from_cookiejar
-.. autofunction:: cookiejar_from_dict
-.. autofunction:: add_dict_to_cookiejar
+.. autofunction:: requests.utils.dict_from_cookiejar
+.. autofunction:: requests.utils.cookiejar_from_dict
+.. autofunction:: requests.utils.add_dict_to_cookiejar
 
 
 Encodings
 ~~~~~~~~~
 
-.. autofunction:: get_encodings_from_content
-.. autofunction:: get_encoding_from_headers
-.. autofunction:: get_unicode_from_response
-.. autofunction:: decode_gzip
+.. autofunction:: requests.utils.get_encodings_from_content
+.. autofunction:: requests.utils.get_encoding_from_headers
+.. autofunction:: requests.utils.get_unicode_from_response
 
 
 Classes