sphinx.testing.util

module documentation

Sphinx test suite utilities

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Sphinx​Test​App A subclass of Sphinx that runs on the test root, with some better default values for the initialization parameters.
Class ​Sphinx​Test​App​Wrapper​For​Skip​Building 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):

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
root:strUndocumented
suffix:boolUndocumented
Returns
Generator[str, None, None]Undocumented
def simple_decorator(f):
A simple decorator that does nothing, for tests to use.
def strip_escseq(text):

Undocumented

Parameters
text:strUndocumented
Returns
strUndocumented
_unicode_literals_re =

Undocumented