diff options
| author | Kenneth Reitz <me@kennethreitz.com> | 2011-05-16 01:13:05 -0400 |
|---|---|---|
| committer | Kenneth Reitz <me@kennethreitz.com> | 2011-05-16 01:13:05 -0400 |
| commit | 6e13e7343d2d1a37fe61365c7658984bcf4d9194 (patch) | |
| tree | 99e5bd29f1c2b6329276d531a5026bad7fd73c25 /docs/api.rst | |
| parent | f9f3b46ef6f5266099e351243f4068c100274d0b (diff) | |
| download | python-requests-6e13e7343d2d1a37fe61365c7658984bcf4d9194.tar.gz | |
Big API update
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/docs/api.rst b/docs/api.rst index a7d4285c..cabc0e77 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,14 +1,60 @@ +.. _api: + API === +.. module:: requests + +This part of the documentation covers all the interfaces of Requests. For +parts where Requests depends on external libraries, we document the most +important right here and provide links to the canonical documentation. + Main Interface -------------- +.. autofunction:: get +.. autofunction:: post +.. autofunction:: put +.. autofunction:: delete +.. autofunction:: head + +.. autoclass:: requests.models.Response + :inherited-members: + Exceptions ---------- +.. autoexception:: HTTPError + +.. autoexception:: RequestException + +.. autoexception:: requests.models.AuthenticationError +.. autoexception:: requests.models.URLRequired +.. autoexception:: requests.models.InvalidMethod + Internals ----------
\ No newline at end of file +--------- + +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 |