sphinx.testing.util.SphinxTestApp

class documentation

class SphinxTestApp(application.Sphinx):

View In Hierarchy

A subclass of Sphinx that runs on the test root, with some better default values for the initialization parameters.
Method __init__ Undocumented
Method __repr__ Undocumented
Method cleanup Undocumented
Class Variable ​_status Undocumented
Class Variable ​_warning Undocumented
Instance Variable ​_saved​_directives Undocumented
Instance Variable ​_saved​_nodeclasses Undocumented
Instance Variable ​_saved​_path Undocumented
Instance Variable ​_saved​_roles Undocumented

Inherited from Sphinx:

Method add​_autodoc​_attrgetter Register a new getattr-like function for the autodoc extension.
Method add​_autodocumenter Register a new documenter class for the autodoc extension.
Method add​_builder Register a new builder.
Method add​_config​_value Register a configuration value.
Method add​_crossref​_type Register a new crossref object type.
Method add​_css​_file Register a stylesheet to include in the HTML output.
Method add​_directive Register a Docutils directive.
Method add​_directive​_to​_domain Register a Docutils directive in a domain.
Method add​_domain Register a domain.
Method add​_enumerable​_node Register a Docutils node class as a numfig target.
Method add​_env​_collector Register an environment collector class.
Method add​_event Register an event called name.
Method add​_generic​_role Register a generic Docutils role.
Method add​_html​_math​_renderer Register a math renderer for HTML.
Method add​_html​_theme Register a HTML Theme.
Method add​_index​_to​_domain Register a custom index for a domain.
Method add​_js​_file Register a JavaScript file to include in the HTML output.
Method add​_latex​_package Register a package to include in the LaTeX source code.
Method add​_lexer Register a new lexer for source code.
Method add​_message​_catalog Register a message catalog.
Method add​_node Register a Docutils node class.
Method add​_object​_type Register a new object type.
Method add​_post​_transform Register a Docutils transform to be applied before writing.
Method add​_role Register a Docutils role.
Method add​_role​_to​_domain Register a Docutils role in a domain.
Method add​_search​_language Register a new language for the HTML search index.
Method add​_source​_parser Register a parser class.
Method add​_source​_suffix Register a suffix of source files.
Method add​_transform Register a Docutils transform to be applied after parsing.
Method connect Register callback to be called when event is emitted.
Method disconnect Unregister callback by listener_id.
Method emit Emit event and pass arguments to the callback functions.
Method emit​_firstresult Emit event and pass arguments to the callback functions.
Method is​_parallel​_allowed Check whether parallel processing is allowed or not.
Method require​_sphinx Check the Sphinx version if requested.
Method set​_translator Register or override a Docutils translator class.
Method setup​_extension Import and setup a Sphinx extension module.
Instance Variable confdir Directory containing conf.py.
Instance Variable doctreedir Directory for storing pickled doctrees.
Instance Variable outdir Directory for storing build documents.
Instance Variable project Undocumented
Instance Variable srcdir Directory containing source.
Method ​_init​_builder Undocumented
Method ​_init​_env Undocumented
Method ​_init​_i18n Load translated strings from the configured localedirs if enabled in the configuration.
Method add​_stylesheet An alias of add_css_file.
Method build Undocumented
Method create​_builder Undocumented
Method preload​_builder Undocumented
Method set​_html​_assets​_policy Set the policy to include assets in HTML pages.
Instance Variable ​_warncount Undocumented
Instance Variable builder Undocumented
Instance Variable config Undocumented
Instance Variable env Undocumented
Instance Variable events Undocumented
Instance Variable extensions Undocumented
Instance Variable keep​_going Undocumented
Instance Variable messagelog Undocumented
Instance Variable parallel Undocumented
Instance Variable phase Undocumented
Instance Variable quiet Undocumented
Instance Variable registry Undocumented
Instance Variable statuscode Undocumented
Instance Variable tags Undocumented
Instance Variable translator Undocumented
Instance Variable verbosity Undocumented
Instance Variable warningiserror Undocumented
Property html​_themes Undocumented
def __init__(self, buildername='html', srcdir=None, builddir=None, freshenv=False, confoverrides=None, status=None, warning=None, tags=None, docutilsconf=None, parallel=0):
overrides sphinx.application.Sphinx.__init__

Undocumented

Parameters
buildername:strUndocumented
srcdir:pathUndocumented
builddir:pathUndocumented
freshenv:boolUndocumented
confoverrides:DictUndocumented
status:IOUndocumented
warning:IOUndocumented
tags:List[str]Undocumented
docutilsconf:strUndocumented
parallel:intUndocumented
def __repr__(self):

Undocumented

Returns
strUndocumented
def cleanup(self, doctrees=False):

Undocumented

Parameters
doctrees:boolUndocumented
_status: StringIO =
overrides sphinx.application.Sphinx._status

Undocumented

_warning: StringIO =
overrides sphinx.application.Sphinx._warning

Undocumented

_saved_directives =

Undocumented

_saved_nodeclasses =

Undocumented

_saved_path =

Undocumented

_saved_roles =

Undocumented