Commit Graph

481 Commits

Author SHA1 Message Date
David Pursehouse 49ecffb86e Add authentication classes to the API document
Change-Id: Ic1464f246602b809f3c29fbafd6f36b747d5d5df
2014-07-18 15:15:54 +09:00
David Pursehouse f0fb20cd83 Fix name misspelling
Change-Id: Ied3e600e5673eff48558b634b3c2616d13a3337b
2014-07-16 15:13:11 +09:00
David Pursehouse 2a6303e018 Docs: Fix :class: and :meth: directives
A few instances of the directives were malformed and did not
result in hyperlinks in the generated HTML.

Change-Id: I94d93de928ee4ff24a48797baf2ac77598a20704
2014-07-16 10:50:57 +09:00
Ian Cordasco d21916c0ff Merge pull request #2134 from nonZero/patch-1
removed unneeded parentheses from if clause
2014-07-15 12:13:09 -05:00
Udi Oron 6dc13f2194 removed unneeded parentheses from if clause 2014-07-15 19:56:47 +03:00
David Pursehouse a8a4c9828a Restructure "Redirection and History" section in quickstart documentation
Change-Id: Ida38d551e8cd0edaeb92d09de411a6f4a3d0578b
2014-07-15 18:44:13 +09:00
David Pursehouse f5a2138e8c Minor tidy-ups in quickstart documentation
Change-Id: Ia862c17707a2a76182c549db88821636e8402729
2014-07-15 18:27:50 +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
David Pursehouse 504b960fb4 Documentation: Add Sony to list of users
Change-Id: I0568f27562e5d12f7e5e528b216ca1b1e9cd8256
2014-07-15 17:53:18 +09:00
David Pursehouse d9ea1aaeb0 Documentation: Wrap lines in index.rst
Wrap lines at 80 characters where possible.

Change-Id: Ib254734a7a18b62f965577c368929058258b489f
2014-07-15 17:53:14 +09:00
Tshepang Lekhonkhobe 36b6c37496 Fix broken link 2014-07-14 16:13:23 +02:00
Espartaco Palma 291bc9ea07 Update link to pip site on docs/user/install.rst 2014-07-04 11:42:56 -05:00
Ian Cordasco d25280dc20 Replace dead link with StackOverflow answer 2014-07-02 10:34:25 -05:00
np-csu 1bf4af6395 Update quickstart.rst
line 394: correct an input error.
2014-06-29 21:05:04 +08:00
Benjamin Kerensa c451dd2c77 Update out-there.rst
Remove french blog post which is now a deadlink.
2014-06-15 00:10:09 -07:00
kennethreitz b80ed77cdd Update index.rst 2014-06-11 16:40:23 -04:00
Cory Benfield 22433163b3 Update trivial mentions to RFC 2616. 2014-06-07 09:53:12 +01:00
Cory Benfield a2413e010f Ensure that we open files in binary mode. 2014-05-28 16:59:57 +01:00
Martin Geisler f4d1bbb7c5 faq: add Python 3.4 to list of supported Python versions
No code changes were necessary for this.
2014-05-26 16:20:03 +02:00
Martin Geisler 5eea4a3767 faq: mention that PyPy 2.2 works too
The FAQ says that PyPy 1.9 is supported. On my Debian Unstable, I can
install PyPy 2.2.1 and the tests work with that version too.
2014-05-26 16:19:17 +02:00
Paweł Romanowski a7e7241616 Fix typo in advanced.rst docs
`Sesssion` -> `Session`
2014-05-13 10:11:40 +02:00
Kenneth Reitz 7fa9799e28 sidebar update 2014-04-26 09:28:05 -04:00
Kenneth Reitz 3e568eb3b0 sidebar update 2014-04-26 09:27:06 -04:00
Cory Benfield 6c1ddeedfb First pass at update to philosophy section. 2014-04-18 17:28:12 +01:00
Kenneth Reitz b2c801f3c7 Merge remote-tracking branch 'origin/master' 2014-04-15 19:07:52 -04:00
Kenneth Reitz f409d65d15 12,000,000 2014-04-15 19:01:41 -04:00
kennethreitz 338c5f6a0b Merge pull request #1991 from gutworth/patch-1
replace reference to crate.io
2014-04-08 10:19:39 -04:00
Cory Benfield 6f52970a6d Reinstate '$'. 2014-04-05 17:29:00 +01:00
Benjamin Peterson fb2380c3cc delete pypi mirror section 2014-04-05 11:57:43 -04:00
Ionel Cristian Mărieș 96936b5616 Make it more clear where install commands are run (so that newbies don't run them in the REPL, I've seen it happen :). 2014-04-05 16:40:13 +03:00
Benjamin Peterson 8a23dd94cb replace reference to crate.io
crate.io is gone, so a different mirror should be used as an example. Also, the list of PyPI mirrors should be mentioned.
2014-04-04 23:58:18 -04:00
Kenneth Reitz a3cd2f3929 Merge remote-tracking branch 'origin/master' 2014-03-24 11:39:20 -04:00
Kenneth Reitz b2db089eef 3.4 2014-03-24 11:39:15 -04:00
Cory Benfield 03f444e601 Timeout documentation changes. 2014-03-03 20:23:59 +00:00
Aaron Iles 98b76f4b98 State early in SNI discussion Python2 limitation
Reference at the earliest opportunity that Server-Name-Indication is a
limitation of Python 2.6 and 2.7. Avoid describing it as a Requests
issue.
2014-02-04 21:08:11 +11:00
Aaron Iles 8a0bae45c2 Move SNI documentation to FAQ
Relocate documentation on Server-Name-Indication from the advanced
section to the frequently asked questions. This is minus details on
enabling SNI on Python2, which is instead captured by linking to Stack
Overflow.
2014-02-02 22:19:10 +11:00
Aaron Iles b5b8198fd1 Document requirements for SNI support on Python2
A section for Request's advanced usage guide on what Server Name
Indication is, its purpose, and how to enable it on Python2.
2014-02-02 20:14:05 +11:00
Alexander 1e3eb4ef9e Added info about posted files headers 2014-01-28 12:03:59 +03:00
Ian Cordasco 3bd16ce9c5 Add missing sled
Thanks @kevinburke
2014-01-21 19:55:00 -06:00
Ian Cordasco 799bf116fe Add a small note about requests-toolbelt 2014-01-18 22:44:50 -06:00
Cory Benfield 476ab203bc Document contextlib.closing. 2014-01-16 08:37:29 +00:00
Cory Benfield ac4e05874a Fixup the header heirarchy. 2014-01-09 19:50:56 +00:00
Cory Benfield 098865122c Merge branch 'master' of github.com:dsoprea/requests
Conflicts:
	docs/user/advanced.rst
2014-01-09 19:46:32 +00:00
Dustin Oprea 3ccdfce2e5 Added an SSL TA example. 2014-01-09 11:41:30 -05:00
kennethreitz 632304209c Merge pull request #1831 from kevinburke/interlinks
Add more interlinks between the documentation
2014-01-08 10:48:25 -08:00
kennethreitz e93b07eef6 Merge pull request #1832 from kevinburke/docs-warnings
Fix warnings when building the docs
2014-01-08 10:45:33 -08:00
Ian Cordasco 14a1839a45 No one checks docs or a license 2014-01-02 16:05:29 -06:00
Kevin Burke a0e7706440 Fix warnings when building the docs
It may be nice to make builds fail if new documentation generates warnings, to
avoid these sorts of problems slipping in in the future.
2013-12-28 00:09:29 -08:00
Kevin Burke fad8d743b5 Add more interlinks between the documentation
Also fixes up tense in a few cases, and adds the `intersphinx` extension so we
can link to the urllib3 documentation when it is called out.
2013-12-27 23:43:55 -08:00
Cory Benfield 4a6a0c3c65 Update docs to highlight the value of r.encoding. 2013-12-20 09:15:12 +00:00