abjad.sphinx

`abjad.ext.sphinx.embed_images`(self, node, ...)
`abjad.ext.sphinx.install_lightbox_static_files`(app)
`abjad.ext.sphinx.on_builder_inited`(app)
`abjad.ext.sphinx.on_html_collect_pages`(app)
`abjad.ext.sphinx.setup`(app)
`abjad.ext.sphinx.thumbnail_block`([rawsource])
`abjad.ext.sphinx.visit_thumbnail_block_html`(...)
`abjad.ext.sphinx.visit_thumbnail_block_latex`(...)
`abjad.ext.sphinx.AbjadClassDocumenter`(...)	Abjad class documenter.
`abjad.ext.sphinx.AbjadFunctionDocumenter`(...)	Abjad function documenter.
`abjad.ext.sphinx.AbjadModuleDocumenter`(...)	Abjad module documenter.
`abjad.ext.sphinx.AbjadRootDocumenter`([...])	Abjad root documenter.
`abjad.ext.sphinx.HiddenDoctestDirective`(...)	Hidden doctest directive.
`abjad.ext.sphinx.LilyPondExtension`(...[, ...])
`abjad.ext.sphinx.ShellDirective`(name, ...)	Shell directive.
`abjad.ext.sphinx.ThumbnailDirective`(name, ...)	Thumbnail directive.

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]

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

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

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

class abjad.ext.sphinx.AbjadClassDocumenter(package_path: str)[source]: Abjad class documenter.

class abjad.ext.sphinx.AbjadFunctionDocumenter(package_path: str)[source]: Abjad function documenter.

class abjad.ext.sphinx.AbjadModuleDocumenter(package_path: str, document_private_members: bool = False, member_documenter_classes: Sequence[Type[MemberDocumenter]] | None = None, module_documenters: Sequence[ModuleDocumenter] | None = None)[source]

Abjad module documenter.

Writes …

abjad/docs/source/api/abjad/bind.rst

abjad/docs/source/api/abjad/configuration.rst

abjad/docs/source/api/abjad/contextmanagers.rst

etc.

… to disk.

member_documenters_by_section

overridden member_documenters_by_section

class abjad.ext.sphinx.AbjadRootDocumenter(module_documenters=None, title='API')[source]

Abjad root documenter.

Writes abjad/docs/source/api/index.rst.

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

Hidden doctest directive.

Contributes no formatting to documents built by Sphinx.

run()

Executes the directive.

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

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

to_docutils()

to_docutils()[source]

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

Shell directive.

Represents a shell session.

Generates a docutils literal_block node.

run()

overridden run()[source]

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

Thumbnail directive.

run()

Executes the directive.

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