sphinx¶

Classes

`HiddenDoctestDirective`	A hidden doctest directive.
`LilyPondExtension`
`ShellDirective`	A shell directive.
`ThumbnailDirective`	A thumbnail directive.
`thumbnail_block`

class abjad.ext.sphinx.HiddenDoctestDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

A hidden doctest directive.

Contributes no formatting to documents built by Sphinx.

Attributes Summary

`final_argument_whitespace`	May the final argument contain whitespace?
`has_content`	May the directive have content?
`option_spec`	Mapping of option names to validator functions.
`optional_arguments`	Number of optional arguments after the required arguments.
`required_arguments`	Number of required directive arguments.
`run`	Executes the directive.

Methods

overridden run()[source]¶: Executes the directive.

class abjad.ext.sphinx.LilyPondExtension(illustrable, kind, no_trim=None, pages=None, with_columns=None, **keywords)[source]¶

Attributes Summary

`Kind`
`lilypond_block`
`setup_console`	Perform console setup tasks before executing a suite of code blocks, e.g.
`setup_sphinx`	Setup Sphinx, e.g.
`to_docutils`
`visit_block_html`

Methods

to_docutils()[source]¶

Class & static methods

classmethod (Extension).add_option(key, value)¶

static (Extension).depart_block_text(self, node)¶

overridden classmethod setup_console(console, monkeypatch)[source]¶: Perform console setup tasks before executing a suite of code blocks, e.g. monkeypatching IO operations to allow media capture.

overridden classmethod setup_sphinx(app)[source]¶: Setup Sphinx, e.g. register custom nodes and visitors.

classmethod (Extension).teardown_console(app)¶: Perform console teardown tasks.

overridden static visit_block_html(self, node)[source]¶

static (Extension).visit_block_latex(self, node)¶

static (Extension).visit_block_text(self, node)¶

class abjad.ext.sphinx.ShellDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

A shell directive.

Represents a shell session.

Generates a docutils literal_block node.

Attributes Summary

`final_argument_whitespace`	May the final argument contain whitespace?
`has_content`	May the directive have content?
`option_spec`	Mapping of option names to validator functions.
`optional_arguments`	Number of optional arguments after the required arguments.
`required_arguments`	Number of required directive arguments.
`run`

Methods

overridden run()[source]¶

class abjad.ext.sphinx.ThumbnailDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

A thumbnail directive.

Attributes Summary

`final_argument_whitespace`	May the final argument contain whitespace?
`has_content`	May the directive have content?
`option_spec`	Mapping of option names to validator functions.
`optional_arguments`	Number of optional arguments after the required arguments.
`required_arguments`	Number of required directive arguments.
`run`	Executes the directive.

Methods

overridden run()[source]¶: Executes the directive.

class abjad.ext.sphinx.thumbnail_block(rawsource='', *children, **attributes)[source]¶

Functions

`embed_images`
`install_lightbox_static_files`
`on_builder_inited`
`on_html_collect_pages`
`setup`
`visit_thumbnail_block_html`
`visit_thumbnail_block_latex`

abjad.ext.sphinx.embed_images(self, node, output_directory, render_prefix, source_path)[source]¶

abjad.ext.sphinx.install_lightbox_static_files(app)[source]¶

abjad.ext.sphinx.on_builder_inited(app)[source]¶

abjad.ext.sphinx.on_html_collect_pages(app)[source]¶

abjad.ext.sphinx.setup(app)[source]¶

abjad.ext.sphinx.visit_thumbnail_block_html(self, node)[source]¶

abjad.ext.sphinx.visit_thumbnail_block_latex(self, node)[source]¶