')
+ else:
+ BaseTranslator.visit_caption(self, node)
+ self.add_fignumber(node.parent)
+ self.body.append(self.starttag(node, 'span', '', CLASS='caption-text'))
+
+ def depart_caption(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('')
+
+ # append permalink if available
+ if isinstance(node.parent, nodes.container) and node.parent.get('literal_block'):
+ self.add_permalink_ref(node.parent, _('Permalink to this code'))
+ elif isinstance(node.parent, nodes.figure):
+ image_nodes = node.parent.traverse(nodes.image)
+ target_node = image_nodes and image_nodes[0] or node.parent
+ self.add_permalink_ref(target_node, _('Permalink to this image'))
+ elif node.parent.get('toctree'):
+ self.add_permalink_ref(node.parent.parent, _('Permalink to this toctree'))
+
+ if isinstance(node.parent, nodes.container) and node.parent.get('literal_block'):
+ self.body.append('
\n')
+ else:
+ BaseTranslator.depart_caption(self, node)
+
+ def visit_doctest_block(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_literal_block(node)
+
+ # overwritten to add the (for XHTML compliance)
+ def visit_block_quote(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(self.starttag(node, 'blockquote') + '
')
+
+ def depart_block_quote(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('
\n')
+
+ # overwritten
+ def visit_literal(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(self.starttag(node, 'code', '',
+ CLASS='docutils literal'))
+ self.protect_literal_text += 1
+
+ def depart_literal(self, node):
+ # type: (nodes.Node) -> None
+ self.protect_literal_text -= 1
+ self.body.append('')
+
+ def visit_productionlist(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(self.starttag(node, 'pre'))
+ names = []
+ for production in node:
+ names.append(production['tokenname'])
+ maxlen = max(len(name) for name in names)
+ lastname = None
+ for production in node:
+ if production['tokenname']:
+ lastname = production['tokenname'].ljust(maxlen)
+ self.body.append(self.starttag(production, 'strong', ''))
+ self.body.append(lastname + ' ::= ')
+ elif lastname is not None:
+ self.body.append('%s ' % (' ' * len(lastname)))
+ production.walkabout(self)
+ self.body.append('\n')
+ self.body.append('\n')
+ raise nodes.SkipNode
+
+ def depart_productionlist(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_production(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def depart_production(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_centered(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(self.starttag(node, 'p', CLASS="centered") +
+ '
')
+
+ def depart_centered(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('')
+
+ # overwritten
+ def should_be_compact_paragraph(self, node):
+ # type: (nodes.Node) -> bool
+ """Determine if the
tags around paragraph can be omitted."""
+ if isinstance(node.parent, addnodes.desc_content):
+ # Never compact desc_content items.
+ return False
+ if isinstance(node.parent, addnodes.versionmodified):
+ # Never compact versionmodified nodes.
+ return False
+ return BaseTranslator.should_be_compact_paragraph(self, node)
+
+ def visit_compact_paragraph(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def depart_compact_paragraph(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_highlightlang(self, node):
+ # type: (nodes.Node) -> None
+ self.highlightlang = node['lang']
+ self.highlightlinenothreshold = node['linenothreshold']
+
+ def depart_highlightlang(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_download_reference(self, node):
+ # type: (nodes.Node) -> None
+ if self.builder.download_support and node.hasattr('filename'):
+ self.body.append(
+ '' %
+ posixpath.join(self.builder.dlpath, node['filename']))
+ self.context.append('')
+ else:
+ self.context.append('')
+
+ def depart_download_reference(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(self.context.pop())
+
+ # overwritten
+ def visit_image(self, node):
+ # type: (nodes.Node) -> None
+ olduri = node['uri']
+ # rewrite the URI if the environment knows about it
+ if olduri in self.builder.images:
+ node['uri'] = posixpath.join(self.builder.imgpath,
+ self.builder.images[olduri])
+
+ uri = node['uri']
+ if uri.lower().endswith(('svg', 'svgz')):
+ atts = {'src': uri}
+ if 'width' in node:
+ atts['width'] = node['width']
+ if 'height' in node:
+ atts['height'] = node['height']
+ atts['alt'] = node.get('alt', uri)
+ if 'align' in node:
+ self.body.append('
' %
+ (node['align'], node['align']))
+ self.context.append('
\n')
+ else:
+ self.context.append('')
+ self.body.append(self.emptytag(node, 'img', '', **atts))
+ return
+
+ if 'scale' in node:
+ # Try to figure out image height and width. Docutils does that too,
+ # but it tries the final file name, which does not necessarily exist
+ # yet at the time the HTML file is written.
+ if not ('width' in node and 'height' in node):
+ size = get_image_size(os.path.join(self.builder.srcdir, olduri))
+ if size is None:
+ logger.warning('Could not obtain image size. :scale: option is ignored.',
+ location=node)
+ else:
+ if 'width' not in node:
+ node['width'] = str(size[0])
+ if 'height' not in node:
+ node['height'] = str(size[1])
+ BaseTranslator.visit_image(self, node)
+
+ # overwritten
+ def depart_image(self, node):
+ # type: (nodes.Node) -> None
+ if node['uri'].lower().endswith(('svg', 'svgz')):
+ self.body.append(self.context.pop())
+ else:
+ BaseTranslator.depart_image(self, node)
+
+ def visit_toctree(self, node):
+ # type: (nodes.Node) -> None
+ # this only happens when formatting a toc from env.tocs -- in this
+ # case we don't want to include the subtree
+ raise nodes.SkipNode
+
+ def visit_index(self, node):
+ # type: (nodes.Node) -> None
+ raise nodes.SkipNode
+
+ def visit_tabular_col_spec(self, node):
+ # type: (nodes.Node) -> None
+ raise nodes.SkipNode
+
+ def visit_glossary(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def depart_glossary(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_acks(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def depart_acks(self, node):
+ # type: (nodes.Node) -> None
+ pass
+
+ def visit_hlist(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('
')
+
+ def depart_hlist(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('
\n')
+
+ def visit_hlistcol(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('
')
+
+ def depart_hlistcol(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append(' | ')
+
+ def bulk_text_processor(self, text):
+ # type: (unicode) -> unicode
+ return text
+
+ # overwritten
+ def visit_Text(self, node):
+ # type: (nodes.Node) -> None
+ text = node.astext()
+ encoded = self.encode(text)
+ if self.protect_literal_text:
+ # moved here from base class's visit_literal to support
+ # more formatting in literal nodes
+ for token in self.words_and_spaces.findall(encoded):
+ if token.strip():
+ # protect literal text from line wrapping
+ self.body.append('
%s' % token)
+ elif token in ' \n':
+ # allow breaks at whitespace
+ self.body.append(token)
+ else:
+ # protect runs of multiple spaces; the last one can wrap
+ self.body.append(' ' * (len(token) - 1) + ' ')
+ else:
+ if self.in_mailto and self.settings.cloak_email_addresses:
+ encoded = self.cloak_email(encoded)
+ else:
+ encoded = self.bulk_text_processor(encoded)
+ self.body.append(encoded)
+
+ def visit_note(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'note')
+
+ def depart_note(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition(node)
+
+ def visit_warning(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'warning')
+
+ def depart_warning(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition(node)
+
+ def visit_attention(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'attention')
+
+ def depart_attention(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_caution(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'caution')
+
+ def depart_caution(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_danger(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'danger')
+
+ def depart_danger(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_error(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'error')
+
+ def depart_error(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_hint(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'hint')
+
+ def depart_hint(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_important(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'important')
+
+ def depart_important(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ def visit_tip(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_admonition(node, 'tip')
+
+ def depart_tip(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_admonition()
+
+ # these are only handled specially in the SmartyPantsHTML5Translator
+ def visit_literal_emphasis(self, node):
+ # type: (nodes.Node) -> None
+ return self.visit_emphasis(node)
+
+ def depart_literal_emphasis(self, node):
+ # type: (nodes.Node) -> None
+ return self.depart_emphasis(node)
+
+ def visit_literal_strong(self, node):
+ # type: (nodes.Node) -> None
+ return self.visit_strong(node)
+
+ def depart_literal_strong(self, node):
+ # type: (nodes.Node) -> None
+ return self.depart_strong(node)
+
+ def visit_abbreviation(self, node):
+ # type: (nodes.Node) -> None
+ attrs = {}
+ if node.hasattr('explanation'):
+ attrs['title'] = node['explanation']
+ self.body.append(self.starttag(node, 'abbr', '', **attrs))
+
+ def depart_abbreviation(self, node):
+ # type: (nodes.Node) -> None
+ self.body.append('')
+
+ def visit_manpage(self, node):
+ # type: (nodes.Node) -> None
+ self.visit_literal_emphasis(node)
+
+ def depart_manpage(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_literal_emphasis(node)
+
+ # overwritten to add even/odd classes
+
+ def visit_table(self, node):
+ # type: (nodes.Node) -> None
+ self._table_row_index = 0
+
+ classes = [cls.strip(u' \t\n')
+ for cls in self.settings.table_style.split(',')]
+ classes.insert(0, "docutils") # compat
+ if 'align' in node:
+ classes.append('align-%s' % node['align'])
+ tag = self.starttag(node, 'table', CLASS=' '.join(classes))
+ self.body.append(tag)
+
+ def visit_row(self, node):
+ # type: (nodes.Node) -> None
+ self._table_row_index += 1
+ if self._table_row_index % 2 == 0:
+ node['classes'].append('row-even')
+ else:
+ node['classes'].append('row-odd')
+ self.body.append(self.starttag(node, 'tr', ''))
+ node.column = 0
+
+ def visit_field_list(self, node):
+ # type: (nodes.Node) -> None
+ self._fieldlist_row_index = 0
+ return BaseTranslator.visit_field_list(self, node)
+
+ def visit_field(self, node):
+ # type: (nodes.Node) -> None
+ self._fieldlist_row_index += 1
+ if self._fieldlist_row_index % 2 == 0:
+ node['classes'].append('field-even')
+ else:
+ node['classes'].append('field-odd')
+ return node
+
+ def visit_math(self, node, math_env=''):
+ # type: (nodes.Node, unicode) -> None
+ logger.warning('using "math" markup without a Sphinx math extension '
+ 'active, please use one of the math extensions '
+ 'described at http://sphinx-doc.org/ext/math.html',
+ location=(self.builder.current_docname, node.line))
+ raise nodes.SkipNode
+
+ def unknown_visit(self, node):
+ # type: (nodes.Node) -> None
+ raise NotImplementedError('Unknown node: ' + node.__class__.__name__)
+
+
+class SmartyPantsHTML5Translator(HTML5Translator):
+ """
+ Handle ordinary text via smartypants, converting quotes and dashes
+ to the correct entities.
+ """
+
+ def __init__(self, *args, **kwds):
+ # type: (Any, Any) -> None
+ self.no_smarty = 0
+ HTML5Translator.__init__(self, *args, **kwds)
+
+ def visit_literal(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ try:
+ # this raises SkipNode
+ HTML5Translator.visit_literal(self, node)
+ finally:
+ self.no_smarty -= 1
+
+ def visit_literal_block(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ try:
+ HTML5Translator.visit_literal_block(self, node)
+ except nodes.SkipNode:
+ # HTML5Translator raises SkipNode for simple literal blocks,
+ # but not for parsed literal blocks
+ self.no_smarty -= 1
+ raise
+
+ def depart_literal_block(self, node):
+ # type: (nodes.Node) -> None
+ HTML5Translator.depart_literal_block(self, node)
+ self.no_smarty -= 1
+
+ def visit_literal_emphasis(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ self.visit_emphasis(node)
+
+ def depart_literal_emphasis(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_emphasis(node)
+ self.no_smarty -= 1
+
+ def visit_literal_strong(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ self.visit_strong(node)
+
+ def depart_literal_strong(self, node):
+ # type: (nodes.Node) -> None
+ self.depart_strong(node)
+ self.no_smarty -= 1
+
+ def visit_desc_signature(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ HTML5Translator.visit_desc_signature(self, node)
+
+ def depart_desc_signature(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty -= 1
+ HTML5Translator.depart_desc_signature(self, node)
+
+ def visit_productionlist(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ try:
+ HTML5Translator.visit_productionlist(self, node)
+ finally:
+ self.no_smarty -= 1
+
+ def visit_option(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty += 1
+ HTML5Translator.visit_option(self, node)
+
+ def depart_option(self, node):
+ # type: (nodes.Node) -> None
+ self.no_smarty -= 1
+ HTML5Translator.depart_option(self, node)
+
+ def bulk_text_processor(self, text):
+ # type: (unicode) -> unicode
+ if self.no_smarty <= 0:
+ return sphinx_smarty_pants(text)
+ return text
diff --git a/tests/test_build_html.py b/tests/test_build_html.py
index ab228c13c..58b89445e 100644
--- a/tests/test_build_html.py
+++ b/tests/test_build_html.py
@@ -109,9 +109,9 @@ def check_xpath(etree, fname, path, check, be_found=True):
# Since pygments-2.1.1, empty
tag is inserted at top of
# highlighting block
if len(node) == 1 and node[0].tag == 'span' and node[0].text is None:
- return node[0].tail
- else:
- return ''
+ if node[0].tail is not None:
+ return node[0].tail
+ return ''
rex = re.compile(check)
if be_found:
diff --git a/tests/test_build_html5.py b/tests/test_build_html5.py
new file mode 100644
index 000000000..b491b6306
--- /dev/null
+++ b/tests/test_build_html5.py
@@ -0,0 +1,330 @@
+# -*- coding: utf-8 -*-
+"""
+ test_build_html5
+ ~~~~~~~~~~~~~~~~
+
+ Test the HTML5 writer and check output against XPath.
+
+ This code is digest to reduce test running time.
+ Complete test code is here:
+
+ https://github.com/sphinx-doc/sphinx/pull/2805/files
+
+ :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+"""
+
+import os
+import re
+from itertools import cycle, chain
+import xml.etree.cElementTree as ElementTree
+
+from six import PY3
+import pytest
+from html5lib import getTreeBuilder, HTMLParser
+
+from sphinx import __display_version__
+from sphinx.util.docutils import is_html5_writer_available
+
+from util import remove_unicode_literals, strip_escseq, skip_unless
+from test_build_html import flat_dict, tail_check, check_xpath
+
+TREE_BUILDER = getTreeBuilder('etree', implementation=ElementTree)
+HTML_PARSER = HTMLParser(TREE_BUILDER, namespaceHTMLElements=False)
+
+
+etree_cache = {}
+
+@skip_unless(is_html5_writer_available())
+@pytest.fixture(scope='module')
+def cached_etree_parse():
+ def parse(fname):
+ if fname in etree_cache:
+ return etree_cache[fname]
+ with (fname).open('rb') as fp:
+ etree = HTML_PARSER.parse(fp)
+ etree_cache.clear()
+ etree_cache[fname] = etree
+ return etree
+ yield parse
+ etree_cache.clear()
+
+
+@skip_unless(is_html5_writer_available())
+@pytest.mark.parametrize("fname,expect", flat_dict({
+ 'images.html': [
+ (".//img[@src='_images/img.png']", ''),
+ (".//img[@src='_images/img1.png']", ''),
+ (".//img[@src='_images/simg.png']", ''),
+ (".//img[@src='_images/svgimg.svg']", ''),
+ (".//a[@href='_sources/images.txt']", ''),
+ ],
+ 'subdir/images.html': [
+ (".//img[@src='../_images/img1.png']", ''),
+ (".//img[@src='../_images/rimg.png']", ''),
+ ],
+ 'subdir/includes.html': [
+ (".//a[@href='../_downloads/img.png']", ''),
+ (".//img[@src='../_images/img.png']", ''),
+ (".//p", 'This is an include file.'),
+ (".//pre/span", 'line 1'),
+ (".//pre/span", 'line 2'),
+ ],
+ 'includes.html': [
+ (".//pre", u'Max Strauß'),
+ (".//a[@href='_downloads/img.png']", ''),
+ (".//a[@href='_downloads/img1.png']", ''),
+ (".//pre/span", u'"quotes"'),
+ (".//pre/span", u"'included'"),
+ (".//pre/span[@class='s2']", u'üöä'),
+ (".//div[@class='inc-pyobj1 highlight-text']//pre",
+ r'^class Foo:\n pass\n\s*$'),
+ (".//div[@class='inc-pyobj2 highlight-text']//pre",
+ r'^ def baz\(\):\n pass\n\s*$'),
+ (".//div[@class='inc-lines highlight-text']//pre",
+ r'^class Foo:\n pass\nclass Bar:\n$'),
+ (".//div[@class='inc-startend highlight-text']//pre",
+ u'^foo = "Including Unicode characters: üöä"\\n$'),
+ (".//div[@class='inc-preappend highlight-text']//pre",
+ r'(?m)^START CODE$'),
+ (".//div[@class='inc-pyobj-dedent highlight-python']//span",
+ r'def'),
+ (".//div[@class='inc-tab3 highlight-text']//pre",
+ r'-| |-'),
+ (".//div[@class='inc-tab8 highlight-python']//pre/span",
+ r'-| |-'),
+ ],
+ 'autodoc.html': [
+ (".//dt[@id='test_autodoc.Class']", ''),
+ (".//dt[@id='test_autodoc.function']/em", r'\*\*kwds'),
+ (".//dd/p", r'Return spam\.'),
+ ],
+ 'extapi.html': [
+ (".//strong", 'from function: Foo'),
+ (".//strong", 'from class: Bar'),
+ ],
+ 'markup.html': [
+ (".//title", 'set by title directive'),
+ (".//p/em", 'Section author: Georg Brandl'),
+ (".//p/em", 'Module author: Georg Brandl'),
+ # created by the meta directive
+ (".//meta[@name='author'][@content='Me']", ''),
+ (".//meta[@name='keywords'][@content='docs, sphinx']", ''),
+ # a label created by ``.. _label:``
+ (".//div[@id='label']", ''),
+ # code with standard code blocks
+ (".//pre", '^some code$'),
+ # an option list
+ (".//span[@class='option']", '--help'),
+ # admonitions
+ (".//p[@class='admonition-title']", 'My Admonition'),
+ (".//div[@class='admonition note']/p", 'Note text.'),
+ (".//div[@class='admonition warning']/p", 'Warning text.'),
+ # inline markup
+ (".//li/p/strong", r'^command\\n$'),
+ (".//li/p/strong", r'^program\\n$'),
+ (".//li/p/em", r'^dfn\\n$'),
+ (".//li/p/code/span[@class='pre']", r'^kbd\\n$'),
+ (".//li/p/span", u'File \N{TRIANGULAR BULLET} Close'),
+ (".//li/p/code/span[@class='pre']", '^a/$'),
+ (".//li/p/code/em/span[@class='pre']", '^varpart$'),
+ (".//li/p/code/em/span[@class='pre']", '^i$'),
+ (".//a[@href='https://www.python.org/dev/peps/pep-0008']"
+ "[@class='pep reference external']/strong", 'PEP 8'),
+ (".//a[@href='https://www.python.org/dev/peps/pep-0008']"
+ "[@class='pep reference external']/strong",
+ 'Python Enhancement Proposal #8'),
+ (".//a[@href='https://tools.ietf.org/html/rfc1.html']"
+ "[@class='rfc reference external']/strong", 'RFC 1'),
+ (".//a[@href='https://tools.ietf.org/html/rfc1.html']"
+ "[@class='rfc reference external']/strong", 'Request for Comments #1'),
+ (".//a[@href='objects.html#envvar-HOME']"
+ "[@class='reference internal']/code/span[@class='pre']", 'HOME'),
+ (".//a[@href='#with']"
+ "[@class='reference internal']/code/span[@class='pre']", '^with$'),
+ (".//a[@href='#grammar-token-try_stmt']"
+ "[@class='reference internal']/code/span", '^statement$'),
+ (".//a[@href='#some-label'][@class='reference internal']/span", '^here$'),
+ (".//a[@href='#some-label'][@class='reference internal']/span", '^there$'),
+ (".//a[@href='subdir/includes.html']"
+ "[@class='reference internal']/span", 'Including in subdir'),
+ (".//a[@href='objects.html#cmdoption-python-c']"
+ "[@class='reference internal']/code/span[@class='pre']", '-c'),
+ # abbreviations
+ (".//abbr[@title='abbreviation']", '^abbr$'),
+ # version stuff
+ (".//div[@class='versionadded']/p/span", 'New in version 0.6: '),
+ (".//div[@class='versionadded']/p/span",
+ tail_check('First paragraph of versionadded')),
+ (".//div[@class='versionchanged']/p/span",
+ tail_check('First paragraph of versionchanged')),
+ (".//div[@class='versionchanged']/p",
+ 'Second paragraph of versionchanged'),
+ # footnote reference
+ (".//a[@class='footnote-reference brackets']", r'1'),
+ # created by reference lookup
+ (".//a[@href='contents.html#ref1']", ''),
+ # ``seealso`` directive
+ (".//div/p[@class='admonition-title']", 'See also'),
+ # a ``hlist`` directive
+ (".//table[@class='hlist']/tbody/tr/td/ul/li/p", '^This$'),
+ # a ``centered`` directive
+ (".//p[@class='centered']/strong", 'LICENSE'),
+ # a glossary
+ (".//dl/dt[@id='term-boson']", 'boson'),
+ # a production list
+ (".//pre/strong", 'try_stmt'),
+ (".//pre/a[@href='#grammar-token-try1_stmt']/code/span", 'try1_stmt'),
+ # tests for ``only`` directive
+ (".//p", 'A global substitution.'),
+ (".//p", 'In HTML.'),
+ (".//p", 'In both.'),
+ (".//p", 'Always present'),
+ # tests for ``any`` role
+ (".//a[@href='#with']/span", 'headings'),
+ (".//a[@href='objects.html#func_without_body']/code/span", 'objects'),
+ ],
+ 'objects.html': [
+ (".//dt[@id='mod.Cls.meth1']", ''),
+ (".//dt[@id='errmod.Error']", ''),
+ (".//dt/code", r'long\(parameter,\s* list\)'),
+ (".//dt/code", 'another one'),
+ (".//a[@href='#mod.Cls'][@class='reference internal']", ''),
+ (".//dl[@class='userdesc']", ''),
+ (".//dt[@id='userdesc-myobj']", ''),
+ (".//a[@href='#userdesc-myobj'][@class='reference internal']", ''),
+ # docfields
+ (".//a[@class='reference internal'][@href='#TimeInt']/em", 'TimeInt'),
+ (".//a[@class='reference internal'][@href='#Time']", 'Time'),
+ (".//a[@class='reference internal'][@href='#errmod.Error']/strong", 'Error'),
+ # C references
+ (".//span[@class='pre']", 'CFunction()'),
+ (".//a[@href='#c.Sphinx_DoSomething']", ''),
+ (".//a[@href='#c.SphinxStruct.member']", ''),
+ (".//a[@href='#c.SPHINX_USE_PYTHON']", ''),
+ (".//a[@href='#c.SphinxType']", ''),
+ (".//a[@href='#c.sphinx_global']", ''),
+ # test global TOC created by toctree()
+ (".//ul[@class='current']/li[@class='toctree-l1 current']/a[@href='#']",
+ 'Testing object descriptions'),
+ (".//li[@class='toctree-l1']/a[@href='markup.html']",
+ 'Testing various markup'),
+ # test unknown field names
+ (".//dt[@class='field-odd']", 'Field_name'),
+ (".//dt[@class='field-even']", 'Field_name all lower'),
+ (".//dt[@class='field-odd']", 'FIELD_NAME'),
+ (".//dt[@class='field-even']", 'FIELD_NAME ALL CAPS'),
+ (".//dt[@class='field-odd']", 'Field_Name'),
+ (".//dt[@class='field-even']", 'Field_Name All Word Caps'),
+ (".//dt[@class='field-odd']", 'Field_name'),
+ (".//dt[@class='field-even']", 'Field_name First word cap'),
+ (".//dt[@class='field-odd']", 'FIELd_name'),
+ (".//dt[@class='field-even']", 'FIELd_name PARTial caps'),
+ # custom sidebar
+ (".//h4", 'Custom sidebar'),
+ # docfields
+ (".//dd[@class='field-odd']/p/strong", '^moo$'),
+ (".//dd[@class='field-odd']/p/strong", tail_check(r'\(Moo\) .* Moo')),
+ (".//dd[@class='field-odd']/ul/li/p/strong", '^hour$'),
+ (".//dd[@class='field-odd']/ul/li/p/em", '^DuplicateType$'),
+ (".//dd[@class='field-odd']/ul/li/p/em", tail_check(r'.* Some parameter')),
+ # others
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-arg-p']/code/span",
+ 'perl'),
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-arg-p']/code/span",
+ '\\+p'),
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-objc']/code/span",
+ '--ObjC\\+\\+'),
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-plugin-option']/code/span",
+ '--plugin.option'),
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-arg-create-auth-token']"
+ "/code/span",
+ 'create-auth-token'),
+ (".//a[@class='reference internal'][@href='#cmdoption-perl-arg-arg']/code/span",
+ 'arg'),
+ (".//a[@class='reference internal'][@href='#cmdoption-hg-arg-commit']/code/span",
+ 'hg'),
+ (".//a[@class='reference internal'][@href='#cmdoption-hg-arg-commit']/code/span",
+ 'commit'),
+ (".//a[@class='reference internal'][@href='#cmdoption-git-commit-p']/code/span",
+ 'git'),
+ (".//a[@class='reference internal'][@href='#cmdoption-git-commit-p']/code/span",
+ 'commit'),
+ (".//a[@class='reference internal'][@href='#cmdoption-git-commit-p']/code/span",
+ '-p'),
+ ],
+ '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'),
+ (".//li[@class='toctree-l2']/a", 'Inline markup'),
+ (".//title", 'Sphinx '),
+ (".//div[@class='footer']", 'Georg Brandl & Team'),
+ (".//a[@href='http://python.org/']"
+ "[@class='reference external']", ''),
+ (".//li/p/a[@href='genindex.html']/span", 'Index'),
+ (".//li/p/a[@href='py-modindex.html']/span", 'Module Index'),
+ (".//li/p/a[@href='search.html']/span", 'Search Page'),
+ # custom sidebar only for contents
+ (".//h4", 'Contents sidebar'),
+ # custom JavaScript
+ (".//script[@src='file://moo.js']", ''),
+ # URL in contents
+ (".//a[@class='reference external'][@href='http://sphinx-doc.org/']",
+ 'http://sphinx-doc.org/'),
+ (".//a[@class='reference external'][@href='http://sphinx-doc.org/latest/']",
+ 'Latest reference'),
+ # Indirect hyperlink targets across files
+ (".//a[@href='markup.html#some-label'][@class='reference internal']/span",
+ '^indirect hyperref$'),
+ ],
+ 'bom.html': [
+ (".//title", " File with UTF-8 BOM"),
+ ],
+ 'extensions.html': [
+ (".//a[@href='http://python.org/dev/']", "http://python.org/dev/"),
+ (".//a[@href='http://bugs.python.org/issue1000']", "issue 1000"),
+ (".//a[@href='http://bugs.python.org/issue1042']", "explicit caption"),
+ ],
+ '_static/statictmpl.html': [
+ (".//project", 'Sphinx '),
+ ],
+ 'genindex.html': [
+ # index entries
+ (".//a/strong", "Main"),
+ (".//a/strong", "[1]"),
+ (".//a/strong", "Other"),
+ (".//a", "entry"),
+ (".//li/a", "double"),
+ ],
+ 'footnote.html': [
+ (".//a[@class='footnote-reference brackets'][@href='#id8'][@id='id1']", r"1"),
+ (".//a[@class='footnote-reference brackets'][@href='#id9'][@id='id2']", r"2"),
+ (".//a[@class='footnote-reference brackets'][@href='#foo'][@id='id3']", r"3"),
+ (".//a[@class='reference internal'][@href='#bar'][@id='id4']", r"\[bar\]"),
+ (".//a[@class='footnote-reference brackets'][@href='#id10'][@id='id5']", r"4"),
+ (".//a[@class='footnote-reference brackets'][@href='#id11'][@id='id6']", r"5"),
+ (".//a[@class='fn-backref'][@href='#id1']", r"1"),
+ (".//a[@class='fn-backref'][@href='#id2']", r"2"),
+ (".//a[@class='fn-backref'][@href='#id3']", r"3"),
+ (".//a[@class='fn-backref'][@href='#id4']", r"bar"),
+ (".//a[@class='fn-backref'][@href='#id5']", r"4"),
+ (".//a[@class='fn-backref'][@href='#id6']", r"5"),
+ (".//a[@class='fn-backref'][@href='#id7']", r"6"),
+ ],
+ 'otherext.html': [
+ (".//h1", "Generated section"),
+ (".//a[@href='_sources/otherext.foo.txt']", ''),
+ ]
+}))
+@pytest.mark.sphinx('html', tags=['testtag'], confoverrides={
+ 'html_context.hckey_co': 'hcval_co',
+ 'html_experimental_html5_writer': True})
+@pytest.mark.test_params(shared_result='test_build_html5_output')
+def test_html5_output(app, cached_etree_parse, fname, expect):
+ app.build()
+ print(app.outdir / fname)
+ check_xpath(cached_etree_parse(app.outdir / fname), fname, *expect)