cleanup and documentation

constrains.txt

@@ -1,6 +1,14 @@
 # Constrains for testing Diazo / Plone Packages
 # ---------------------------------------------
 
+# tox (Test invocation tool) + virtualenv:
+tox==2.7.0
+virtualenv==15.1.0
+
+# coverage and coveralls:
+coverage==4.4.1
+coveralls==1.2.0
+
 # lint tools (flake8, isort + plugins):
 flake8==3.4.1
 flake8-blind-except==0.1.1

tox.ini

@@ -1,7 +1,6 @@
-# Tox (http://tox.testrun.org/) is a tool for running tests
-# in multiple virtualenvs. This configuration file will run the
-# test suite on all supported python versions. To use it, "pip install tox"
-# and then run "tox" from this directory.
+# Tox (http://tox.testrun.org/) is a tool for running tests in multiple virtualenvs.
+# This configuration file will run the test suite on all supported python versions.
+# To use it, "pip install -c constrains.txt tox" and then run "tox" from this directory.
 
 [tox]
 envlist =
@@ -72,14 +71,14 @@ deps =
     flake8
     # helper to generate HTML reports:
     flake8-html
+    # Useful flake8 plugins that are Python and Plone specific:
     flake8-blind-except
     flake8-coding
     flake8-commas
     flake8-debugger
     flake8-deprecated
     flake8-isort
     flake8-pep3101
-#    flake8-plone-api
     flake8-plone-hasattr
     flake8-print
     flake8-quotes
@@ -114,6 +113,7 @@ commands = {[lint]commands}
 basepython = python2.7
 commands =
     sphinx-build -b html -d build/docs/doctrees docs build/docs/html
+    # The following line should be enabled if we do have testable code in the docs.
     #sphinx-build -b doctest docs build/docs/doctrees
 deps =
     -cconstrains.txt