Merge branch 'master' of github.com:sphinx-doc/sphinx

tests/conftest.py

@@ -8,12 +8,20 @@
 """
 
 import os
+import sys
 
 import pytest
 from sphinx.testing.path import path
 
 pytest_plugins = 'sphinx.testing.fixtures'
 
+# Exclude 'roots' dirs for pytest test collector
+collect_ignore = ['roots']
+
+# Disable Python version-specific
+if sys.version_info < (3, 5):
+    collect_ignore += ['py35']
+
 
 @pytest.fixture(scope='session')
 def rootdir():

tests/roots/test-builder-gettext-dont-rebuild-mo/bom.rst

@@ -0,0 +1,5 @@
+File with UTF-8 BOM
+===================
+
+This file has a UTF-8 "BOM".
+

tests/roots/test-builder-gettext-dont-rebuild-mo/conf.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+master_doc = 'index'
+
+latex_documents = [
+    (master_doc, 'test.tex', 'The basic Sphinx documentation for testing', 'Sphinx', 'report')
+]

tests/roots/test-builder-gettext-dont-rebuild-mo/index.rst

@@ -0,0 +1,6 @@
+The basic Sphinx documentation for testing
+==========================================
+
+.. toctree::
+
+   bom

tests/roots/test-root/_static/README

@@ -1 +0,0 @@
-This whole directory is there to test html_static_path.

tests/roots/test-root/_static/excluded.css

@@ -1 +0,0 @@
-/* This file should be excluded from being copied over */

tests/roots/test-root/_static/subdir/foo.css

@@ -1 +0,0 @@
-/* Stub file */

tests/roots/test-root/conf.py

@@ -29,16 +29,11 @@ numfig = True
 
 rst_epilog = '.. |subst| replace:: global substitution'
 
-html_theme = 'testtheme'
-html_theme_path = ['.']
-html_theme_options = {'testopt': 'testoverride'}
 html_sidebars = {'**': ['localtoc.html', 'relations.html', 'sourcelink.html',
                         'customsb.html', 'searchbox.html'],
                  'contents': ['contentssb.html', 'localtoc.html',
                               'globaltoc.html']}
 html_style = 'default.css'
-html_static_path = ['_static', 'templated.css_t']
-html_extra_path = ['robots.txt']
 html_last_updated_fmt = '%b %d, %Y'
 html_context = {'hckey': 'hcval', 'hckey_co': 'wrong_hcval_co'}
 

tests/roots/test-root/robots.txt

@@ -1,2 +0,0 @@
-User-agent: *
-Disallow: /cgi-bin/

tests/roots/test-root/subdir.po

@@ -1,9 +0,0 @@
-#, fuzzy
-msgid ""
-msgstr ""
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-msgid "Including in subdir"
-msgstr "translation"

tests/roots/test-root/templated.css_t

@@ -1,2 +0,0 @@
-/* Stub file, templated */
-{{ sphinx_version }}

tests/run.py

@@ -55,14 +55,5 @@ os.makedirs(tempdir)
 print('Running Sphinx test suite (with Python %s)...' % sys.version.split()[0])
 sys.stdout.flush()
 
-# exclude 'roots' dirs for pytest test collector
-ignore_paths = [
-    os.path.relpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), sub))
-    for sub in ('roots',)
-]
-args = sys.argv[1:]
-for ignore_path in ignore_paths:
-    args.extend(['--ignore', ignore_path])
-
 import pytest  # NOQA
-sys.exit(pytest.main(args))
+sys.exit(pytest.main(sys.argv[1:]))

tests/test_autodoc.py

@@ -1108,53 +1108,3 @@ class EnumCls(enum.Enum):
     val2 = 23  #: doc for val2
     val3 = 34
     """doc for val3"""
-
-
-def test_type_hints():
-    from sphinx.ext.autodoc import formatargspec
-    from sphinx.util.inspect import getargspec
-
-    try:
-        from typing_test_data import f0, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11
-    except (ImportError, SyntaxError):
-        pytest.skip('Cannot import Python code with function annotations')
-
-    def verify_arg_spec(f, expected):
-        assert formatargspec(f, *getargspec(f)) == expected
-
-    # Class annotations
-    verify_arg_spec(f0, '(x: int, y: numbers.Integral) -> None')
-
-    # Generic types with concrete parameters
-    verify_arg_spec(f1, '(x: typing.List[int]) -> typing.List[int]')
-
-    # TypeVars and generic types with TypeVars
-    verify_arg_spec(f2, '(x: typing.List[T],'
-                        ' y: typing.List[T_co],'
-                        ' z: T) -> typing.List[T_contra]')
-
-    # Union types
-    verify_arg_spec(f3, '(x: typing.Union[str, numbers.Integral]) -> None')
-
-    # Quoted annotations
-    verify_arg_spec(f4, '(x: str, y: str) -> None')
-
-    # Keyword-only arguments
-    verify_arg_spec(f5, '(x: int, *, y: str, z: str) -> None')
-
-    # Keyword-only arguments with varargs
-    verify_arg_spec(f6, '(x: int, *args, y: str, z: str) -> None')
-
-    # Space around '=' for defaults
-    verify_arg_spec(f7, '(x: int = None, y: dict = {}) -> None')
-
-    # Callable types
-    verify_arg_spec(f8, '(x: typing.Callable[[int, str], int]) -> None')
-    verify_arg_spec(f9, '(x: typing.Callable) -> None')
-
-    # Tuple types
-    verify_arg_spec(f10, '(x: typing.Tuple[int, str],'
-                         ' y: typing.Tuple[int, ...]) -> None')
-
-    # Instance annotations
-    verify_arg_spec(f11, '(x: CustomAnnotation, y: 123) -> None')

tests/test_build.py

@@ -59,13 +59,14 @@ def nonascii_srcdir(request, rootdir, sphinx_test_tempdir):
     return srcdir
 
 
+# note: this test skips building docs for some builders because they have independent testcase.
+#       (html, latex, texinfo and manpage)
 @pytest.mark.parametrize(
     "buildername",
     [
         # note: no 'html' - if it's ok with dirhtml it's ok with html
-        'dirhtml', 'singlehtml', 'latex', 'texinfo', 'pickle', 'json', 'text',
-        'htmlhelp', 'qthelp', 'epub', 'applehelp', 'changes', 'xml',
-        'pseudoxml', 'man', 'linkcheck',
+        'dirhtml', 'singlehtml', 'pickle', 'json', 'text', 'htmlhelp', 'qthelp',
+        'epub', 'applehelp', 'changes', 'xml', 'pseudoxml', 'linkcheck',
     ],
 )
 @mock.patch('sphinx.builders.linkcheck.requests.head',

tests/test_build_html.py

@@ -126,24 +126,6 @@ def check_xpath(etree, fname, path, check, be_found=True):
                                               [node.text for node in nodes]))
 
 
-def check_static_entries(outdir):
-    staticdir = outdir / '_static'
-    assert staticdir.isdir()
-    # a file from a directory entry in html_static_path
-    assert (staticdir / 'README').isfile()
-    # a directory from a directory entry in html_static_path
-    assert (staticdir / 'subdir' / 'foo.css').isfile()
-    # a file from a file entry in html_static_path
-    assert (staticdir / 'templated.css').isfile()
-    assert (staticdir / 'templated.css').text().splitlines()[1] == __display_version__
-    # a file from _static, but matches exclude_patterns
-    assert not (staticdir / 'excluded.css').exists()
-
-
-def check_extra_entries(outdir):
-    assert (outdir / 'robots.txt').isfile()
-
-
 @pytest.mark.sphinx('html', testroot='warnings')
 def test_html_warnings(app, warning):
     app.build()
@@ -156,15 +138,6 @@ def test_html_warnings(app, warning):
         '--- Got:\n' + html_warnings
 
 
-@pytest.mark.sphinx('html', tags=['testtag'], confoverrides={
-    'html_context.hckey_co': 'hcval_co'})
-@pytest.mark.test_params(shared_result='test_build_html_output')
-def test_static_output(app):
-    app.build()
-    check_static_entries(app.builder.outdir)
-    check_extra_entries(app.builder.outdir)
-
-
 @pytest.mark.parametrize("fname,expect", flat_dict({
     'images.html': [
         (".//img[@src='_images/img.png']", ''),
@@ -377,7 +350,6 @@ def test_static_output(app):
     'contents.html': [
         (".//meta[@name='hc'][@content='hcval']", ''),
         (".//meta[@name='hc_co'][@content='hcval_co']", ''),
-        (".//meta[@name='testopt'][@content='testoverride']", ''),
         (".//td[@class='label']", r'\[Ref1\]'),
         (".//td[@class='label']", ''),
         (".//li[@class='toctree-l1']/a", 'Testing various markup'),
@@ -410,9 +382,6 @@ def test_static_output(app):
         (".//a[@href='http://bugs.python.org/issue1000']", "issue 1000"),
         (".//a[@href='http://bugs.python.org/issue1042']", "explicit caption"),
     ],
-    '_static/statictmpl.html': [
-        (".//project", 'Sphinx <Tests>'),
-    ],
     'genindex.html': [
         # index entries
         (".//a/strong", "Main"),
@@ -1145,16 +1114,28 @@ def test_html_assets(app):
     assert not (app.outdir / 'subdir' / '.htpasswd').exists()
 
 
-@pytest.mark.sphinx('html', confoverrides={'html_sourcelink_suffix': ''})
+@pytest.mark.sphinx('html', testroot='basic', confoverrides={'html_copy_source': False})
+def test_html_copy_source(app):
+    app.builder.build_all()
+    assert not (app.outdir / '_sources' / 'index.rst.txt').exists()
+
+
+@pytest.mark.sphinx('html', testroot='basic', confoverrides={'html_sourcelink_suffix': '.txt'})
 def test_html_sourcelink_suffix(app):
     app.builder.build_all()
-    content_otherext = (app.outdir / 'otherext.html').text()
-    content_images = (app.outdir / 'images.html').text()
+    assert (app.outdir / '_sources' / 'index.rst.txt').exists()
 
-    assert '<a href="_sources/otherext.foo"' in content_otherext
-    assert '<a href="_sources/images.txt"' in content_images
-    assert (app.outdir / '_sources' / 'otherext.foo').exists()
-    assert (app.outdir / '_sources' / 'images.txt').exists()
+
+@pytest.mark.sphinx('html', testroot='basic', confoverrides={'html_sourcelink_suffix': '.rst'})
+def test_html_sourcelink_suffix_same(app):
+    app.builder.build_all()
+    assert (app.outdir / '_sources' / 'index.rst').exists()
+
+
+@pytest.mark.sphinx('html', testroot='basic', confoverrides={'html_sourcelink_suffix': ''})
+def test_html_sourcelink_suffix_empty(app):
+    app.builder.build_all()
+    assert (app.outdir / '_sources' / 'index.rst').exists()
 
 
 @pytest.mark.sphinx('html', testroot='html_entity')

tests/test_build_html5.py

@@ -251,7 +251,6 @@ def cached_etree_parse():
     'contents.html': [
         (".//meta[@name='hc'][@content='hcval']", ''),
         (".//meta[@name='hc_co'][@content='hcval_co']", ''),
-        (".//meta[@name='testopt'][@content='testoverride']", ''),
         (".//dt[@class='label']/span[@class='brackets']", r'Ref1'),
         (".//dt[@class='label']", ''),
         (".//li[@class='toctree-l1']/a", 'Testing various markup'),
@@ -284,9 +283,6 @@ def cached_etree_parse():
         (".//a[@href='http://bugs.python.org/issue1000']", "issue 1000"),
         (".//a[@href='http://bugs.python.org/issue1042']", "explicit caption"),
     ],
-    '_static/statictmpl.html': [
-        (".//project", 'Sphinx <Tests>'),
-    ],
     'genindex.html': [
         # index entries
         (".//a/strong", "Main"),

tests/test_ext_math.py

@@ -9,11 +9,25 @@
     :license: BSD, see LICENSE for details.
 """
 
+import os
 import re
+import subprocess
 
 import pytest
 
 
+def has_binary(binary):
+    try:
+        subprocess.check_output([binary])
+    except OSError as e:
+        if e.errno == os.errno.ENOENT:
+            # handle file not found error.
+            return False
+        else:
+            return True
+    return True
+
+
 @pytest.mark.sphinx(
     'html', testroot='ext-math',
     confoverrides = {'extensions': ['sphinx.ext.jsmath'], 'jsmath_path': 'dummy.js'})
@@ -34,6 +48,8 @@ def test_jsmath(app, status, warning):
     assert '<div class="math">\na + 1 &lt; b</div>' in content
 
 
+@pytest.mark.skipif(not has_binary('dvipng'),
+                    reason='Requires dvipng" binary')
 @pytest.mark.sphinx('html', testroot='ext-math-simple',
                     confoverrides = {'extensions': ['sphinx.ext.imgmath']})
 def test_imgmath_png(app, status, warning):
@@ -49,6 +65,8 @@ def test_imgmath_png(app, status, warning):
     assert re.search(html, content, re.S)
 
 
+@pytest.mark.skipif(not has_binary('dvisvgm'),
+                    reason='Requires dvisvgm" binary')
 @pytest.mark.sphinx('html', testroot='ext-math-simple',
                     confoverrides={'extensions': ['sphinx.ext.imgmath'],
                                    'imgmath_image_format': 'svg'})

tests/test_intl.py

@@ -520,7 +520,7 @@ def test_gettext_buildr_ignores_only_directive(app):
 
 @sphinx_intl
 # use individual shared_result directory to avoid "incompatible doctree" error
-@pytest.mark.test_params(shared_result='test_gettext_dont_rebuild_mo')
+@pytest.mark.sphinx(testroot='builder-gettext-dont-rebuild-mo')
 def test_gettext_dont_rebuild_mo(make_app, app_params, build_mo):
     # --- don't rebuild by .mo mtime
     def get_number_of_update_targets(app_):
@@ -533,7 +533,7 @@ def test_gettext_dont_rebuild_mo(make_app, app_params, build_mo):
     app0 = make_app('dummy', *args, **kwargs)
     build_mo(app0.srcdir)
     app0.build()
-    assert (app0.srcdir / 'bom.mo')
+    assert (app0.srcdir / 'xx' / 'LC_MESSAGES' / 'bom.mo').exists()
     # Since it is after the build, the number of documents to be updated is 0
     assert get_number_of_update_targets(app0) == 0
     # When rewriting the timestamp of mo file, the number of documents to be

tests/test_theming.py

@@ -17,6 +17,7 @@ from sphinx.theming import ThemeError
 
 
 @pytest.mark.sphinx(
+    testroot='theming',
     confoverrides={'html_theme': 'ziptheme',
                    'html_theme_options.testopt': 'foo'})
 def test_theme_api(app, status, warning):
@@ -25,10 +26,11 @@ def test_theme_api(app, status, warning):
     # test Theme class API
     assert set(app.html_themes.keys()) == \
         set(['basic', 'default', 'scrolls', 'agogo', 'sphinxdoc', 'haiku',
-             'traditional', 'testtheme', 'ziptheme', 'epub', 'nature',
-             'pyramid', 'bizstyle', 'classic', 'nonav'])
-    assert app.html_themes['testtheme'] == app.srcdir / 'testtheme'
+             'traditional', 'epub', 'nature', 'pyramid', 'bizstyle', 'classic', 'nonav',
+             'test-theme', 'ziptheme', 'staticfiles', 'parent', 'child'])
+    assert app.html_themes['test-theme'] == app.srcdir / 'test_theme' / 'test-theme'
     assert app.html_themes['ziptheme'] == app.srcdir / 'ziptheme.zip'
+    assert app.html_themes['staticfiles'] == app.srcdir / 'test_theme' / 'staticfiles'
 
     # test Theme instance API
     theme = app.builder.theme
@@ -97,6 +99,21 @@ def test_nested_zipped_theme(app, status, warning):
     app.build()  # => not raises TemplateNotFound
 
 
+@pytest.mark.sphinx(testroot='theming',
+                    confoverrides={'html_theme': 'staticfiles'})
+def test_staticfiles(app, status, warning):
+    app.build()
+    assert (app.outdir / '_static' / 'staticimg.png').exists()
+    assert (app.outdir / '_static' / 'statictmpl.html').exists()
+    assert (app.outdir / '_static' / 'statictmpl.html').text() == (
+        '<!-- testing static templates -->\n'
+        '<html><project>Python</project></html>'
+    )
+
+    result = (app.outdir / 'index.html').text()
+    assert '<meta name="testopt" content="optdefault" />' in result
+
+
 @pytest.mark.sphinx(testroot='theming')
 def test_theme_sidebars(app, status, warning):
     app.build()