sphinx.testing.util

module documentation
(source)

Sphinx test suite utilities

Class SphinxTestApp A subclass of :class:`Sphinx` that runs on the test root, with some better default values for the initialization parameters.
Class SphinxTestAppWrapperForSkipBuilding This class is a wrapper for SphinxTestApp to speed up the test by skipping `app.build` process if it is already built and there is even one output file.
Class Struct Undocumented
Function assert_node Undocumented
Function assert_not_re_search Undocumented
Function assert_re_search Undocumented
Function assert_startswith Undocumented
Function etree_parse Undocumented
Function find_files Undocumented
Function simple_decorator A simple decorator that does nothing, for tests to use.
Function strip_escseq Undocumented
Variable _unicode_literals_re Undocumented
def assert_node(node, cls=None, xpath='', **kwargs): (source)

Undocumented

Parameters
node:NodeUndocumented
cls:AnyUndocumented
xpath:strUndocumented
**kwargs:AnyUndocumented
def assert_not_re_search(regex, text, flags=0): (source)

Undocumented

Parameters
regex:re.PatternUndocumented
text:strUndocumented
flags:intUndocumented
def assert_re_search(regex, text, flags=0): (source)

Undocumented

Parameters
regex:re.PatternUndocumented
text:strUndocumented
flags:intUndocumented
def assert_startswith(thing, prefix): (source)

Undocumented

Parameters
thing:strUndocumented
prefix:strUndocumented
def etree_parse(path): (source)

Undocumented

Parameters
path:strUndocumented
Returns
AnyUndocumented
def find_files(root, suffix=None): (source)

Undocumented

Parameters
root:strUndocumented
suffix:str|NoneUndocumented
Returns
Generator[str, None, None]Undocumented
def simple_decorator(f): (source)

A simple decorator that does nothing, for tests to use.

def strip_escseq(text): (source)

Undocumented

Parameters
text:strUndocumented
Returns
strUndocumented
_unicode_literals_re = (source)

Undocumented