module helpgen.sphinxm_mock_app
¶
Short summary¶
module pyquickhelper.helpgen.sphinxm_mock_app
Helpers to convert docstring to various format.
Classes¶
class |
truncated documentation |
---|---|
Properties¶
property |
truncated documentation |
---|---|
|
Methods¶
method |
truncated documentation |
---|---|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
See class Sphinx. |
|
Registers a parser for a specific file extension. |
|
See class Sphinx. |
|
Disconnects a collector given its class name. |
|
See class Sphinx. |
|
See class Sphinx. |
|
Finalizes the documentation after it was parsed. |
|
See class Sphinx. |
|
|
|
See class Sphinx. |
Documentation¶
Helpers to convert docstring to various format.
-
class
pyquickhelper.helpgen.sphinxm_mock_app.
MockSphinxApp
(writer, app, confoverrides, new_extensions=None)[source][source]¶ Bases:
object
Mocks Sphinx application. In memory Sphinx application.
- Parameters
writer – see static method create
app – see static method create
confoverrides – default options
new_extensions – additional extensions
-
__init__
(writer, app, confoverrides, new_extensions=None)[source][source]¶ - Parameters
writer – see static method create
app – see static method create
confoverrides – default options
new_extensions – additional extensions
-
add_autodocumenter
(cls)[source][source]¶ See class Sphinx.
-
add_builder
(name, cl)[source][source]¶ See class Sphinx.
-
add_config_value
(name, default, rebuild, types=())[source][source]¶ See class Sphinx.
-
add_css_file
(css)[source][source]¶ See class Sphinx.
-
add_directive
(name, cl, *args, **options)[source][source]¶ See class Sphinx.
-
add_domain
(domain)[source][source]¶ See class Sphinx.
-
add_env_collector
(collector)[source][source]¶ See class Sphinx.
-
add_event
(name)[source][source]¶ See class Sphinx.
-
add_js_file
(jsfile)[source][source]¶ See class Sphinx.
-
add_mapping
(name, cl)[source][source]¶ See class Sphinx.
-
add_node
(node, **kwds)[source][source]¶ See class Sphinx.
-
add_role
(name, cl)[source][source]¶ See class Sphinx.
-
add_source_parser
(ext, parser, exc=False)[source][source]¶ 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)
-
connect
(node, func)[source][source]¶ See class Sphinx.
-
static
create
(writer='html', directives=None, confoverrides=None, new_extensions=None, load_bokeh=False, destination_path=None, fLOG=None)[source][source]¶ Creates a
MockSphinxApp
for Sphinx.- Parameters
writer –
'sphinx'
is the only allowed valuedirectives – 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 exampletwo functions: see
visit_runpython_node
,depart_runpython_node
as an example
Changed in version 1.8: Parameter load_bokeh was added.
-
disconnect_env_collector
(clname)[source][source]¶ Disconnects a collector given its class name.
- Parameters
cl – name
- Returns
found collector
-
emit
(event, *args)[source][source]¶ See class Sphinx.
-
emit_firstresult
(event, *args)[source][source]¶ See class Sphinx.
-
finalize
(doctree, external_docnames=None)[source][source]¶ Finalizes the documentation after it was parsed.
- Parameters
doctree – doctree (or pub.document), available after publication
external_docnames – other docnames the doctree references
-
get_default_values
()[source][source]¶ See class Sphinx.
-
setup_extension
(extname)[source][source]¶ See class Sphinx.