SphinxDocumentHandler

class abjadbooktools.SphinxDocumentHandler

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_abjadbooktools { graph [label=abjadbooktools]; "abjad.tools.abjadbooktools.SphinxDocumentHandler.SphinxDocumentHandler" [color=black, fontcolor=white, group=1, label=<<B>SphinxDocumentHandler</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=3, group=2, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abjadbooktools.SphinxDocumentHandler.SphinxDocumentHandler"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

cleanup_graphviz_svg(app)
collect_abjad_input_blocks(document)
collect_python_literal_blocks(document[, ...])
errored
find_target_file_paths(...)
get_default_stylesheet()
get_file_base_name(node, image_render_specifier)
get_image_directory_paths()
get_source_extension(node)
install_lightbox_static_files(app)
interpret_code_blocks(app, document)
interpret_image_source(node, ...[, file_format])
interpret_input_blocks(document, ...)
on_autodoc_process_docstring(app, what, ...)
on_build_finished(app, exc)
on_builder_inited(app)
on_doctree_read(app, document)
on_env_updated(app, env)
parse_rst(rst_string)
postprocess_image_target(node, ...[, ...])
rebuild_document(document, blocks)
register_error()
render_png_image(node)
render_svg_image(node)
render_thumbnails(app)
setup_sphinx_extension(app)
should_ignore_document(app, document)
style_document(app, document)
unregister_error()
visit_abjad_import_block(node)
visit_abjad_input_block(node)
visit_abjad_output_block_html(node)
visit_abjad_output_block_latex(node)
visit_abjad_reveal_block(node)
visit_abjad_thumbnail_block_html(node)
visit_abjad_thumbnail_block_latex(node)
write_image_source(node, ...)
__eq__(argument) Is true when ID of argument equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

SphinxDocumentHandler.errored

Methods

SphinxDocumentHandler.collect_abjad_input_blocks(document)
SphinxDocumentHandler.collect_python_literal_blocks(document, renderable_only=True)
SphinxDocumentHandler.get_default_stylesheet()
SphinxDocumentHandler.interpret_input_blocks(document, input_blocks, console)
SphinxDocumentHandler.rebuild_document(document, blocks)
SphinxDocumentHandler.register_error()
SphinxDocumentHandler.unregister_error()

Class & static methods

static SphinxDocumentHandler.cleanup_graphviz_svg(app)
static SphinxDocumentHandler.find_target_file_paths(absolute_directory_path, relative_directory_path, file_name_pattern, pages)
static SphinxDocumentHandler.get_file_base_name(node, image_render_specifier)
static SphinxDocumentHandler.get_image_directory_paths()
static SphinxDocumentHandler.get_source_extension(node)
static SphinxDocumentHandler.install_lightbox_static_files(app)
static SphinxDocumentHandler.interpret_code_blocks(app, document)
static SphinxDocumentHandler.interpret_image_source(node, absolute_source_file_path, absolute_target_file_path, file_format='png')
static SphinxDocumentHandler.on_autodoc_process_docstring(app, what, name, obj, options, lines)
static SphinxDocumentHandler.on_build_finished(app, exc)
static SphinxDocumentHandler.on_builder_inited(app)
static SphinxDocumentHandler.on_doctree_read(app, document)
static SphinxDocumentHandler.on_env_updated(app, env)
static SphinxDocumentHandler.parse_rst(rst_string)
static SphinxDocumentHandler.postprocess_image_target(node, absolute_target_file_path, no_trim=False, no_resize=False)
static SphinxDocumentHandler.render_png_image(node)
static SphinxDocumentHandler.render_svg_image(node)
static SphinxDocumentHandler.render_thumbnails(app)
static SphinxDocumentHandler.setup_sphinx_extension(app)
static SphinxDocumentHandler.should_ignore_document(app, document)
static SphinxDocumentHandler.style_document(app, document)
static SphinxDocumentHandler.visit_abjad_import_block(node)
static SphinxDocumentHandler.visit_abjad_input_block(node)
static SphinxDocumentHandler.visit_abjad_output_block_html(node)
static SphinxDocumentHandler.visit_abjad_output_block_latex(node)
static SphinxDocumentHandler.visit_abjad_reveal_block(node)
static SphinxDocumentHandler.visit_abjad_thumbnail_block_html(node)
static SphinxDocumentHandler.visit_abjad_thumbnail_block_latex(node)
static SphinxDocumentHandler.write_image_source(node, absolute_source_file_path)

Special methods

(AbjadObject).__eq__(argument)

Is true when ID of argument equals ID of Abjad object. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadObject).__hash__()

Hashes Abjad object.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.