From 0c21aa55309a522d29fbca76ecb0aa40eda06abe Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Wed, 17 Aug 2011 04:16:19 -0400 Subject: [PATCH] doc cleanups --- docs/api.rst | 13 +------------ docs/user/advanced.rst | 1 + docs/user/intro.rst | 9 +++++++++ 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index fd02285..cbd24fd 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -22,7 +22,7 @@ all return a :class:`Response ` object. .. autofunction:: put .. autofunction:: patch .. autofunction:: delete - +.. autofunction:: request ----------- @@ -50,19 +50,8 @@ These items are an internal component to Requests, and should never be seen by the end user (developer). This part of the API documentation exists for those who are extending the functionality of Requests. -Functions -~~~~~~~~~ - -.. autofunction:: request - Classes ~~~~~~~ .. autoclass:: requests.models.Request :inherited-members: - -Structures -~~~~~~~~~~ - -.. autoclass:: requests.structures.CaseInsensitiveDict - :inherited-members: \ No newline at end of file diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 83792b5..cdf1abb 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -23,6 +23,7 @@ Let's persist some cookies across requests:: r = s.get("http://httpbin.org/cookies") print r.content + # '{"cookies": {"sessioncookie": "123456789"}}' Sessions can also be used to provide default data to the request methods:: diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 64b49f1..217cb81 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -1,3 +1,5 @@ +.. _introduction: + Introduction ============ @@ -40,14 +42,21 @@ Requests License THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.. _interpreters: Python Interpreters ------------------- At this time, the following Python platforms are officially supported: * cPython 2.5 +* cPython 2.5.5 +* cPython 2.5.6 * cPython 2.6 +* cPython 2.6.6 +* cPython 2.6.7 * cPython 2.7 +* cPython 2.7.1 +* cPython 2.7.2 * PyPy-c 1.4 * PyPy-c 1.5 -- 2.34.1