Add travis ci stage to test for broken links in documentation

Author: nezhar

.travis.yml

@@ -33,8 +33,18 @@ matrix:
           - tox --installpkg ./dist/djangorestframework-*.whl
           - tox  # test sdist
 
+      - python: "3.7"
+        env: DOCS=links
+        script:
+          - pip install -r requirements/requirements-documentation.txt
+          - mkdocs serve &
+          - WAIT_TIME=0 && until nc -vzw 2 localhost 8000 || [ $WAIT_TIME -eq 5 ]; do sleep $(( WAIT_TIME++ )); done
+          - if [ $WAIT_TIME == 5 ]; then echo cannot start mkdocs server on http://localhost:8000; exit 1; fi
+          - pylinkvalidate.py -P http://localhost:8000/
+
     allow_failures:
       - env: DJANGO=master
+      - env: DOCS=links 
 
 install:
     - pip install tox tox-venv tox-travis

requirements/requirements-documentation.txt

@@ -1,2 +1,5 @@
 # MkDocs to build our documentation.
 mkdocs==1.0.4
+
+# pylinkvalidator to check for broken links in documentation.
+pylinkvalidator==0.3