sphinx.application.Sphinx¶
-
class
sphinx.application.Sphinx(srcdir, confdir, outdir, doctreedir, buildername, confoverrides=None, status=<StringIO.StringIO instance>, warning=<open file '<stderr>', mode 'w'>, freshenv=False, warningiserror=False, tags=None, verbosity=0, parallel=0)¶ -
__init__(srcdir, confdir, outdir, doctreedir, buildername, confoverrides=None, status=<StringIO.StringIO instance>, warning=<open file '<stderr>', mode 'w'>, freshenv=False, warningiserror=False, tags=None, verbosity=0, parallel=0)¶
Methods
__init__(srcdir, confdir, outdir, ...[, ...])add_autodoc_attrgetter(type, getter)add_autodocumenter(cls)add_builder(builder)add_config_value(name, default, rebuild[, types])add_crossref_type(directivename, rolename[, ...])add_description_unit(directivename, rolename)add_directive(name, obj[, content, arguments])add_directive_to_domain(domain, name, obj[, ...])add_domain(domain)add_enumerable_node(node, figtype[, ...])add_event(name)add_generic_role(name, nodeclass)add_index_to_domain(domain, index)add_javascript(filename)add_latex_package(packagename[, options])add_lexer(alias, lexer)add_node(node, **kwds)add_object_type(directivename, rolename[, ...])add_role(name, role)add_role_to_domain(domain, name, role)add_search_language(cls)add_source_parser(suffix, parser)add_stylesheet(filename)add_transform(transform)build([force_all, filenames])connect(event, callback)debug(message, *args, **kwargs)Emit a debug-level informational message. debug2(message, *args, **kwargs)Emit a lowlevel debug-level informational message. disconnect(listener_id)emit(event, *args)emit_firstresult(event, *args)import_object(objname[, source])Import an object from a ‘module.name’ string. info([message, nonl])Emit an informational message. old_status_iterator(iterable, summary[, ...])override_domain(domain)require_sphinx(version)set_translator(name, translator_class)setup_extension(extension)Import and setup a Sphinx extension module. status_iterator(iterable, summary[, ...])verbose(message, *args, **kwargs)Emit a verbose informational message. warn(message[, location, prefix, type, subtype])Emit a warning. -