summaryrefslogtreecommitdiff
path: root/docutils/docs/dev
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2020-02-06 15:10:46 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2020-02-06 15:10:46 +0000
commitf724b2eebef922d439629f52777e9eec0fa3d22c (patch)
tree982e5d3751909188afc8b609658c1cc40d798193 /docutils/docs/dev
parent9651bf0fe47e3d89822f9a4dd20c65694f70cdd4 (diff)
downloaddocutils-f724b2eebef922d439629f52777e9eec0fa3d22c.tar.gz
docs: Add a note about using tox to test multiple python
If you've got it, you should use it. Signed-off-by: Stephen Finucane <stephen@that.guru> git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8491 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev')
-rw-r--r--docutils/docs/dev/testing.txt16
1 files changed, 13 insertions, 3 deletions
diff --git a/docutils/docs/dev/testing.txt b/docutils/docs/dev/testing.txt
index 6336f16e7..f896d9ba2 100644
--- a/docutils/docs/dev/testing.txt
+++ b/docutils/docs/dev/testing.txt
@@ -29,6 +29,16 @@ be sure that you haven't broken anything. From a shell::
cd docutils/test
./alltests.py
+You should run this with multiple Python versions. You can use ``tox`` for
+this purpose. To run tests against all supported versions of Python, run::
+
+ tox
+
+To run against a specific version of Python, use the ``pyNN`` environment.
+For example::
+
+ tox -e py37
+
Python Versions
===============
@@ -40,7 +50,7 @@ Docutils 0.16 supports Python 2.7 and Python 3.5 or later.
Therefore, you should install Python 2.7 as well as 3.5 up to the latest Python
(3.7 at the time of this writing) and always run the tests on all of
-them (see `Testing across multiple python versions`_).
+them (see `Testing across multiple python versions`_).
In a pinch, the edge cases (2.7, and 3.7) should cover most of it.
Good resources covering the differences between Python versions:
@@ -51,7 +61,7 @@ Good resources covering the differences between Python versions:
* `What's New in Python 3.7`__
* `PEP 290 - Code Migration and Modernization`__
-__ https://docs.python.org/whatsnew/2.6.html
+__ https://docs.python.org/whatsnew/2.7.html
__ https://docs.python.org/3/whatsnew/3.5.html
__ https://docs.python.org/3/whatsnew/3.6.html
__ https://docs.python.org/3/whatsnew/3.7.html
@@ -60,7 +70,7 @@ __ http://www.python.org/peps/pep-0290.html
.. _Python Check-in Policies: http://www.python.org/dev/tools.html
.. _sandbox directory:
http://docutils.svn.sourceforge.net/svnroot/docutils/trunk/sandbox/
-
+
Testing across multiple python versions
---------------------------------------