Merge pull request #4033 from Lukasa/issue/4030

Test that the readme renders in CI.

.travis.yml

@@ -14,6 +14,8 @@ python:
 install: "make"
 # command to run tests
 script:
+  - |
+    if [[ "$TRAVIS_PYTHON_VERSION" != "2.6" ]] ; then make test-readme; fi
   - make coverage
 after_success:
   - pipenv run codecov

HISTORY.rst

@@ -47,7 +47,7 @@ Release History
 **Bugfixes**
 
 - Much improved handling of non-ASCII ``Location`` header values in redirects.
-  Fewer ``UnicodeDecodeError``s are encountered on Python 2, and Python 3 now
+  Fewer ``UnicodeDecodeErrors`` are encountered on Python 2, and Python 3 now
   correctly understands that Latin-1 is unlikely to be the correct encoding.
 - If an attempt to ``seek`` file to find out its length fails, we now
   appropriately handle that by aborting our content-length calculations.

Makefile

@@ -10,6 +10,9 @@ test:
 	# the -k flag, like "py.test -k test_path_is_not_double_encoded"
 	pipenv run py.test tests
 
+test-readme:
+	pipenv run python setup.py check -r -s
+
 coverage:
 	pipenv run py.test --cov-config .coveragerc --verbose --cov-report term --cov-report xml --cov=requests tests
 

Pipfile

@@ -9,5 +9,6 @@ pytest-httpbin = "==0.0.7"
 pytest-mock = "*"
 pytest-cov = "*"
 alabaster = "*"
+readme_renderer = "*"
 Sphinx = "<=1.5.5"
-PySocks = "*"
+PySocks = "*"