Enable nitpicky Sphinx warnings, update pypy on CI (#140)

* Enable nitpicky Sphinx warnings, fix issues and fail on new issues

* Add the documentation build to .travis.yml and clean up the file

* Test Python 2 PyPy 7.0.0

* Test Python 2 PyPy 7.1.0

* Use Python 2 PyPy 7.0.0 to run the tests

Author: Gallaecio

.travis.yml

@@ -4,7 +4,7 @@ matrix:
   include:
     - python: 2.7
       env: TOXENV=py27
-    - python: 2.7
+    - python: pypy
       env: TOXENV=pypy
     - python: 3.4
       env: TOXENV=py34
@@ -14,27 +14,24 @@ matrix:
       env: TOXENV=py36
     - python: 3.7
       env: TOXENV=py37
-      dist: xenial
-      sudo: true
-    - python: 3.5
+    - python: pypy3
       env: TOXENV=pypy3
+    - python: 3.7
+      env: TOXENV=docs
 
 install:
+  # https://bitbucket.org/pypy/pypy/issues/2389/different-behavior-of-bytesdecode-utf8
+  # The bug above causes Python 2 PyPy 7.1.0+ to fail one test, so below we
+  # install 7.0.0. This can be removed once the Python 2 PyPy version in Travis
+  # includes a fix.
   - |
       if [ "$TOXENV" = "pypy" ]; then
-        export PYPY_VERSION="pypy-6.0.0-linux_x86_64-portable"
+        export PYPY_VERSION="pypy-7.0.0-linux_x86_64-portable"
         wget "https://bitbucket.org/squeaky/portable-pypy/downloads/${PYPY_VERSION}.tar.bz2"
         tar -jxf ${PYPY_VERSION}.tar.bz2
         virtualenv --python="$PYPY_VERSION/bin/pypy" "$HOME/virtualenvs/$PYPY_VERSION"
         source "$HOME/virtualenvs/$PYPY_VERSION/bin/activate"
       fi
-      if [ "$TOXENV" = "pypy3" ]; then
-        export PYPY_VERSION="pypy3.5-6.0.0-linux_x86_64-portable"
-        wget "https://bitbucket.org/squeaky/portable-pypy/downloads/${PYPY_VERSION}.tar.bz2"
-        tar -jxf ${PYPY_VERSION}.tar.bz2
-        virtualenv --python="$PYPY_VERSION/bin/pypy3" "$HOME/virtualenvs/$PYPY_VERSION"
-        source "$HOME/virtualenvs/$PYPY_VERSION/bin/activate"
-      fi
   - pip install -U tox twine wheel codecov
 script: tox
 after_success:

docs/conf.py

@@ -125,7 +125,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -249,3 +249,8 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+
+# --- Nitpicking options ------------------------------------------------------
+
+nitpicky = True

docs/w3lib.rst

@@ -1,28 +1,28 @@
 w3lib Package
 =============
 
-:mod:`encoding` Module
-----------------------
+:mod:`~w3lib.encoding` Module
+-----------------------------
 
 .. automodule:: w3lib.encoding
     :members:
 
 
-:mod:`html` Module
-------------------
+:mod:`~w3lib.html` Module
+-------------------------
 
 .. automodule:: w3lib.html
     :members:
 
 
-:mod:`http` Module
-------------------
+:mod:`~w3lib.http` Module
+-------------------------
 
 .. automodule:: w3lib.http
     :members:
 
-:mod:`url` Module
------------------
+:mod:`~w3lib.url` Module
+------------------------
 
 .. automodule:: w3lib.url
     :members:

tox.ini

@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py27, pypy, py34, py35, py36, py37, pypy3
+envlist = py27, pypy, py34, py35, py36, py37, pypy3, docs
 
 [testenv]
 deps =
@@ -15,3 +15,15 @@ commands =
         --doctest-modules \
         --cov=w3lib --cov-report=term \
         {posargs:w3lib tests}
+
+[docs]
+changedir = docs
+deps =
+    sphinx
+    sphinx_rtd_theme
+
+[testenv:docs]
+changedir = {[docs]changedir}
+deps = {[docs]deps}
+commands =
+    sphinx-build -W -b html . {envtmpdir}/html