SphinxDocumentHandler

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=1]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjadext/book/../../abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; } subgraph "cluster_abjadext.book" { graph [label="abjadext.book"]; node [color=2]; "abjadext.book.SphinxDocumentHandler.SphinxDocumentHandler" [URL="../api/abjadext/book/SphinxDocumentHandler.html#abjadext.book.SphinxDocumentHandler.SphinxDocumentHandler", color=black, fontcolor=white, label="Sphinx\nDocument\nHandler", target=_top]; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "abjad.system.AbjadObject.AbjadObject" -> "abjadext.book.SphinxDocumentHandler.SphinxDocumentHandler"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjadext.book.SphinxDocumentHandler.SphinxDocumentHandler

Attributes Summary

abjad_import_block An abjad import block docutils node.
abjad_input_block An abjad input block docutils node.
abjad_output_block An abjad output block docutils node.
abjad_reveal_block An abjad reveal block docutils node.
abjad_thumbnail_block An Abjad thumbnail block docutils node.
cleanup_graphviz_svg
collect_abjad_input_blocks
collect_python_literal_blocks
errored
find_target_file_paths
get_default_stylesheet
get_file_base_name
get_image_directories
get_source_extension
install_lightbox_static_files
interpret_code_blocks
interpret_image_source
interpret_input_blocks
on_autodoc_process_docstring
on_build_finished
on_builder_inited
on_doctree_read
on_env_updated
parse_rst
postprocess_image_target
rebuild_document
register_error
render_png_image
render_svg_image
render_thumbnails
setup_sphinx_extension
should_ignore_document
unregister_error
visit_abjad_import_block
visit_abjad_input_block
visit_abjad_output_block_html
visit_abjad_output_block_latex
visit_abjad_reveal_block
visit_abjad_thumbnail_block_html
visit_abjad_thumbnail_block_latex
write_image_source

Special methods

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Methods

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

Class & static methods

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

Read-only properties

errored