module helpgen.sphinxm_mock_app

Short summary

module pyquickhelper.helpgen.sphinxm_mock_app

Helpers to convert docstring to various format.

source on GitHub

Classes

class	truncated documentation
MockSphinxApp	Mocks Sphinx application. In memory Sphinx application.

Properties

property	truncated documentation
extensions

Static Methods

staticmethod	truncated documentation
create	Creates a MockSphinxApp for Sphinx.

Methods

method	truncated documentation
__init__
add_autodocumenter	See class Sphinx.
add_builder	See class Sphinx.
add_config_value	See class Sphinx.
add_css_file	See class Sphinx.
add_directive	See class Sphinx.
add_domain	See class Sphinx.
add_env_collector	See class Sphinx.
add_event	See class Sphinx.
add_js_file	See class Sphinx.
add_mapping	See class Sphinx.
add_node	See class Sphinx.
add_role	See class Sphinx.
add_source_parser	Registers a parser for a specific file extension.
connect	See class Sphinx.
disconnect_env_collector	Disconnects a collector given its class name.
emit	See class Sphinx.
emit_firstresult	See class Sphinx.
finalize	Finalizes the documentation after it was parsed.
get_default_values	See class Sphinx.
require_sphinx
setup_extension	See class Sphinx.

Documentation

Helpers to convert docstring to various format.

source on GitHub

class pyquickhelper.helpgen.sphinxm_mock_app.MockSphinxApp(writer, app, confoverrides, new_extensions=None)

Bases: object

Mocks Sphinx application. In memory Sphinx application.

source on GitHub

Parameters

• writer – see static method create

• app – see static method create

• confoverrides – default options

• new_extensions – additional extensions

source on GitHub

__init__(writer, app, confoverrides, new_extensions=None)

Parameters

• writer – see static method create

• app – see static method create

• confoverrides – default options

• new_extensions – additional extensions

source on GitHub

add_autodocumenter(cls)

See class Sphinx.

source on GitHub

add_builder(name, cl)

See class Sphinx.

source on GitHub

add_config_value(name, default, rebuild, types=())

See class Sphinx.

source on GitHub

add_css_file(css)

See class Sphinx.

source on GitHub

add_directive(name, cl, *args, **options)

See class Sphinx.

source on GitHub

add_domain(domain)

See class Sphinx.

source on GitHub

add_env_collector(collector)

See class Sphinx.

source on GitHub

add_event(name)

See class Sphinx.

source on GitHub

add_js_file(jsfile)

See class Sphinx.

source on GitHub

add_mapping(name, cl)

See class Sphinx.

source on GitHub

add_node(node, **kwds)

See class Sphinx.

source on GitHub

add_role(name, cl)

See class Sphinx.

source on GitHub

add_source_parser(ext, parser, exc=False)

Registers a parser for a specific file extension.

Parameters

• ext – file extension

• parser – parser

• exc – raises an exception if already done

Example:

app.add_source_parser(self, ext, parser)

source on GitHub

connect(node, func)

See class Sphinx.

source on GitHub

static create(writer='html', directives=None, confoverrides=None, new_extensions=None, load_bokeh=False, destination_path=None, fLOG=None)

Creates a MockSphinxApp for Sphinx.

Parameters

• writer – 'sphinx' is the only allowed value

• directives – new directives to add (see below)

• confoverrides – initial options

• new_extensions – additional extensions to setup

• load_bokeh – load bokeh extension, disabled by default as it is slow

• destination_path – some extension requires it

• fLOG – logging function

Returns

mockapp, writer, list of added nodes

directives is None or a list of 2 or 5-uple:

• a directive name (mandatory)

• a directive class: see Sphinx Directive, see also RunPythonDirective as an example (mandatory)

• a docutils node: see runpython_node as an example

• two functions: see visit_runpython_node, depart_runpython_node as an example

source on GitHub

disconnect_env_collector(clname)

Disconnects a collector given its class name.

Parameters

cl – name

Returns

found collector

source on GitHub

emit(event, *args)

See class Sphinx.

source on GitHub

emit_firstresult(event, *args)

See class Sphinx.

source on GitHub

finalize(doctree, external_docnames=None)

Finalizes the documentation after it was parsed.

Parameters

• doctree – doctree (or pub.document), available after publication

• external_docnames – other docnames the doctree references

source on GitHub

get_default_values()

See class Sphinx.

source on GitHub

setup_extension(extname)

See class Sphinx.

source on GitHub