Kevin Burke
34ea836d77
tildes
2014-08-29 12:08:03 -07:00
Kevin Burke
81d6b3e435
s/behavior/behaviour
2014-08-29 11:51:09 -07:00
Kevin Burke
dfa41afd43
Document Timeout behaviour
2014-08-29 11:50:11 -07:00
Kevin Burke
c2aeaa3959
Add support for connect timeouts
...
Modifies the timeout interface to also accept a tuple (connect, read) which
would be used to set individual connect and read timeouts for Requests. Adds
Advanced documentation explaining the interface and providing guidance for
timeout values.
2014-08-23 15:12:29 -07:00
David Pursehouse
49ecffb86e
Add authentication classes to the API document
...
Change-Id: Ic1464f246602b809f3c29fbafd6f36b747d5d5df
2014-07-18 15:15:54 +09:00
David Pursehouse
cde5a4a5d5
Add Timeout exception in API documentation
...
The Timeout exception is referenced from quickstart.rst but does
not get hyperlinked.
Change-Id: I69ad881bf9d2475c6239ac7b17f68ddbce0d03cd
2014-07-15 18:27:38 +09:00
Cory Benfield
03f444e601
Timeout documentation changes.
2014-03-03 20:23:59 +00:00
David Fischer
a17f5592f8
Added link to @Lukasa's blog - the source material
2013-09-24 18:59:04 -07:00
David Fischer
fbb8d32c4e
Added migrating to 2.x docs
2013-09-24 18:35:22 -07:00
homm
3440fca2e8
clearly describe r.raw in Body Content Workflow
2013-09-12 13:13:51 +04:00
homm
10b6d77945
remove extra mention of dangerous r.raw
2013-09-12 10:20:47 +04:00
Kwpolska
ca033b83fe
Some cosmetic updates to the docs
...
Signed-off-by: Kwpolska <kwpolska@gmail.com >
2013-07-20 12:12:57 +02:00
amercader
505d2487e3
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.
2013-04-30 16:15:56 +02:00
Chris Warrick
c3bef6b0d9
A tiny typo, noticed while working on the Polish translation.
2013-04-27 14:52:35 +03:00
Sorin Sbarnea
fb49481ddf
Updated documentation indicating that logging is done via requests.packages.urllib3 instead of requests.
...
modified: docs/api.rst
2013-04-10 16:46:05 +01:00
Sorin Sbarnea
17ecb6891c
* Documented the logging, requested in #1297
...
* Added build directory and *.egg to .gitignore
* Added sphinx as setup requirement in order to be able to build documentation with `pyhton setup.py build_sphinx`
modified: .gitignore
modified: docs/api.rst
modified: setup.py
2013-04-10 16:15:28 +01:00
Cory Benfield
c73f653352
Add HTTPAdapter to API docs.
2013-04-09 19:54:47 +01:00
David Fischer
7e7c275504
Session isn't advertised as a context manager
2013-03-02 08:59:19 -08:00
David Fischer
73abf84ace
Capitalize s in Session
2013-03-02 08:51:55 -08:00
David Fischer
7eba5ffe48
Logic on streaming responses was changed in 1.0
...
* prefetch=False in 0.x is now stream=True
2013-03-02 08:44:14 -08:00
David Fischer
1d2ee524d8
Initial docs patch for migrating from pre 1.0
2013-03-01 23:21:08 -08:00
Kenneth Reitz
911e8aec8d
developer interface
2012-12-23 01:50:23 -05:00
Kenneth Reitz
9f89ebe0de
request sessions
2012-12-23 01:49:44 -05:00
Kenneth Reitz
526a0befc7
cleaup api docs
2012-12-23 01:47:35 -05:00
Kenneth Reitz
3ddcc99131
docs update
2012-12-23 01:40:07 -05:00
Kenneth Reitz
aa3347b2a3
request
2012-12-23 01:14:27 -05:00
Kenneth Reitz
b3fbc810d2
no async anymore
2012-12-23 01:02:32 -05:00
Cory Benfield
0792acc130
Update documentation on Sessions.
...
This resolves issue #870 . Better documentation here should be considered
for further work.
2012-11-17 10:57:26 +00:00
Peter Manser
a64a62088a
Fixing status codes. Somehow these were wrong.
2011-11-14 09:44:43 +01:00
Kenneth Reitz
dfbfb2303f
ref
2011-11-09 17:34:59 -08:00
Kenneth Reitz
a0c3570640
better stepping for elastic design
2011-11-09 17:26:13 -08:00
Kenneth Reitz
53bf544050
better api docs
2011-11-09 17:15:44 -08:00
Kenneth Reitz
daf7aeb8c3
Async API
2011-10-13 22:15:55 -04:00
Kenneth Reitz
4a7fdef3ea
Migrate new docs over.
2011-10-13 14:54:36 -04:00
Kenneth Reitz
0c21aa5530
doc cleanups
2011-08-17 04:16:19 -04:00
Kenneth Reitz
f18c40fd36
👍
2011-07-09 10:41:44 -04:00
Kenneth Reitz
15de7d9dba
add PATCH to docs
2011-06-21 22:21:54 -04:00
Kenneth Reitz
7929bb91be
api update
2011-05-16 01:18:09 -04:00
Kenneth Reitz
6e13e7343d
Big API update
2011-05-16 01:13:05 -04:00
Kenneth Reitz
58d5e0318e
api.py -> api.rst
2011-05-15 21:01:44 -04:00