Merge pull request #28 from pganssle/ignore_caches

General cleanup PR

Author: pganssle

.gitignore

@@ -47,6 +47,8 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+.mypy_cache/
+.pytest_cache/
 
 # Translations
 *.mo

README.rst

@@ -4,7 +4,7 @@ variants
 
 
 .. image:: https://img.shields.io/pypi/v/variants.svg
-        :target: https://pypi.python.org/pypi/variants
+        :target: https://pypi.org/project/variants/
 
 .. image:: https://img.shields.io/travis/python-variants/variants.svg
         :target: https://travis-ci.org/python-variants/variants

changelog.d/28.doc.rst

@@ -0,0 +1 @@
+Updated permanent redirect links in documentation.

docs/conf.py

@@ -111,7 +111,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the

docs/installation.rst

@@ -19,7 +19,7 @@ This is the preferred method to install variants, as it will always install the
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
 
-.. _pip: https://pip.pypa.io
+.. _pip: https://pip.pypa.io/en/stable/
 .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
 
 

docs/requirements-docs.txt

@@ -0,0 +1,2 @@
+Sphinx
+sphinx_rtd_theme>=0.3.1

requirements_dev.txt

@@ -1,8 +1,7 @@
-pip
+pip >= 8.0
 wheel
 tox
 coverage
-Sphinx
 singledispatch; python_version <= '3.3'
 pytest >= 3.0; python_version != '3.3'
 pytest <  3.3; python_version == '3.3'

tox.ini

@@ -29,5 +29,6 @@ commands =
 description = invoke sphinx-build to build the HTML docs, check that URIs are valid
 basepython = python3.6
 deps = {[testenv]deps}
+       -r{toxinidir}/docs/requirements-docs.txt
 commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -bhtml}
            sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -blinkcheck}