Re-add Python 2.7 support.

Note: the only reason support was re-added, because no change to the actual code was needed, only to the tests. It is intended as temporary, and may (will) be removed at any time.

Author: macfreek

.github/workflows/tests.yml

@@ -24,6 +24,8 @@ jobs:
           # set them as "X" (without the ".0"), which is undefined in tox.ini.
 
           # Sphinx 1.4 added support for Python 3.5
+          - sphinx: 1.4
+            python: 2.7
           - sphinx: 1.4
             python: 3.5
           - sphinx: '2.0'
@@ -32,6 +34,8 @@ jobs:
           - sphinx: 1.5
             python: 3.6
           # Sphinx 1.8 added support for Python 3.7 and 3.8
+          - sphinx: 1.8
+            python: 2.7
           - sphinx: 1.8
             python: 3.8
           # Sphinx 2.4 added support for Python 3.9

setup.py

@@ -36,13 +36,14 @@
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',
+        'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 3',
         'Topic :: Documentation :: Sphinx',
         'Topic :: Software Development :: Documentation',
         'Topic :: Text Processing :: Markup :: reStructuredText',
     ],
     platforms='any',
-    python_requires='>=3.5',
+    python_requires='>=2.7, !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*',
     packages=find_packages(exclude=['tests']),
     include_package_data=True,
     install_requires=requires,

tests/test_rst_formatting.py

@@ -1,5 +1,6 @@
 from tests.utils import run_parse_test
 
+import pytest
 import sphinx
 
 
@@ -23,12 +24,7 @@ def test_superscript(src_dir, expected_dir, output_dir):
     run_parse_test(src_dir, expected_dir, output_dir, 'common', ['superscript'])
 
 
+@pytest.mark.skipif(sphinx.version_info < (1, 6), reason="Smart quotes were introduces in Sphinx 1.6")
 def test_smart_quotes(src_dir, expected_dir, output_dir):
-    # Smart quotes were only introduces in Sphinx 1.6
-    if sphinx.version_info >= (1, 6):
-        run_parse_test(src_dir, expected_dir, output_dir, 'common', ['smart-quotes'])
-    else:
-        # Support for Sphinx < 1.6
-        # no modification, test against src_dir instead of expected_dir
-        run_parse_test(src_dir, src_dir, output_dir, 'common', ['smart-quotes'])
+    run_parse_test(src_dir, expected_dir, output_dir, 'common', ['smart-quotes'])
 

tests/utils.py

@@ -1,5 +1,10 @@
 from os.path import join
-from itertools import zip_longest
+try:
+    from itertools import zip_longest
+except ImportError:
+    # Python 2.7 support.
+    from itertools import izip_longest as zip_longest
+import io
 
 import docutils
 from docutils.frontend import OptionParser
@@ -92,7 +97,7 @@ def assert_doc_equal(output_doc, expected_doc):
 
 def parse_doc(dir, file):
     parser = Parser()
-    with open(join(dir, file + '.rst')) as fh:
+    with io.open(join(dir, file + '.rst'), encoding='utf-8') as fh:
         doc = new_document(
             file,
             OptionParser(

tox.ini

@@ -1,6 +1,7 @@
 [tox]
 ; If you change the test matrix, also change it in .github/workflows/tests.yml
 envlist =
+    python2.7-sphinx{1.4,1.8}       # Supported by Sphinx 1.0-1.8
     python3.5-sphinx{1.4,2.0,3.4}   # Supported by Sphinx 1.4-3.4
     python3.6-sphinx{1.5,3.4}       # Supported by Sphinx 1.5-4.x
     python3.7-sphinx{3.4}           # Supported by Sphinx 1.8-4.x
@@ -9,6 +10,7 @@ envlist =
 
 [testenv]
 basepython =
+    python2.7: python2.7
     python3.5: python3.5
     python3.6: python3.6
     python3.7: python3.7
@@ -18,19 +20,19 @@ basepython =
 
 deps =
     pytest
-    sphinx1.4: Sphinx >= 1.4, < 1.5
-    sphinx1.5: Sphinx >= 1.5, < 1.6
-    sphinx1.6: Sphinx >= 1.6, < 1.7
-    sphinx1.7: Sphinx >= 1.7, < 1.8
-    sphinx1.8: Sphinx >= 1.8, < 2.0
-    sphinx2.0: Sphinx >= 2.0, < 2.1
-    sphinx2.1: Sphinx >= 2.1, < 2.2
-    sphinx2.2: Sphinx >= 2.2, < 2.3
-    sphinx2.3: Sphinx >= 2.3, < 2.4
-    sphinx2.4: Sphinx >= 2.4, < 3.0
-    sphinx3.0: Sphinx >= 3.0, < 3.1
-    sphinx3.4: Sphinx >= 3.4, < 4.0
-    sphinx4.0: Sphinx >= 4.0, < 4.1
+    sphinx1.4: Sphinx >= 1.4, < 1.5  # Supports Python 2.6, 2.7, 3.3, 3.4, 3.5
+    sphinx1.5: Sphinx >= 1.5, < 1.6  # Supports Python 2.7, 3.4, 3.5
+    sphinx1.6: Sphinx >= 1.6, < 1.7  # Supports Python 2.7, 3.4, 3.5, 3.6
+    sphinx1.7: Sphinx >= 1.7, < 1.8  # Supports Python 2.7, 3.4, 3.5, 3.6
+    sphinx1.8: Sphinx >= 1.8, < 2.0  # Supports Python 2.7, 3.4, 3.5, 3.6, 3.7, 3.8
+    sphinx2.0: Sphinx >= 2.0, < 2.1  # Supports Python 3.4, 3.5, 3.6, 3.7, 3.8
+    sphinx2.1: Sphinx >= 2.1, < 2.2  # Supports Python 3.5, 3.6, 3.7, 3.8
+    sphinx2.2: Sphinx >= 2.2, < 2.3  # Supports Python 3.5, 3.6, 3.7, 3.8
+    sphinx2.3: Sphinx >= 2.3, < 2.4  # Supports Python 3.5, 3.6, 3.7, 3.8
+    sphinx2.4: Sphinx >= 2.4, < 3.0  # Supports Python 3.5, 3.6, 3.7, 3.8, 3.9
+    sphinx3.0: Sphinx >= 3.0, < 3.1  # Supports Python 3.5, 3.6, 3.7, 3.8, 3.9
+    sphinx3.4: Sphinx >= 3.4, < 4.0  # Supports Python 3.5, 3.6, 3.7, 3.8, 3.9
+    sphinx4.0: Sphinx >= 4.0, < 4.1  # Supports Python 3.6, 3.7, 3.8, 3.9
 commands =
     pytest -v