book

Extension for generating Sphinx and LaTeX documentation with embedded notation.

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_abc { graph [label=abc]; node [color=1]; "abc.ABC" [URL="https://docs.python.org/3.6/library/abc.html#abc.ABC", color=1, label=ABC, target=_top]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=2]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjadext/book/../../abjad/system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", color=2, label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjadext/book/../../abjad/system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", color=2, label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph "cluster_abjadext.book" { graph [label="abjadext.book"]; node [color=3]; "abjadext.book.AbjadBookError" [URL="../api/abjadext/book/index.html#abjadext.book.AbjadBookError", color=black, fontcolor=white, label="Abjad\nBook\nError", target=_top]; "abjadext.book.AbjadBookConsole.AbjadBookConsole" [URL="../api/abjadext/book/AbjadBookConsole.html#abjadext.book.AbjadBookConsole.AbjadBookConsole", color=black, fontcolor=white, label="Abjad\nBook\nConsole", target=_top]; "abjadext.book.AbjadBookScript.AbjadBookScript" [URL="../api/abjadext/book/AbjadBookScript.html#abjadext.book.AbjadBookScript.AbjadBookScript", color=black, fontcolor=white, label="Abjad\nBook\nScript", target=_top]; "abjadext.book.CodeBlock.CodeBlock" [URL="../api/abjadext/book/CodeBlock.html#abjadext.book.CodeBlock.CodeBlock", color=black, fontcolor=white, label="Code\nBlock", target=_top]; "abjadext.book.LaTeXDocumentHandler.LaTeXDocumentHandler" [URL="../api/abjadext/book/LaTeXDocumentHandler.html#abjadext.book.LaTeXDocumentHandler.LaTeXDocumentHandler", color=black, fontcolor=white, label="La\nTe\nXDocument\nHandler", target=_top]; "abjadext.book.LilyPondBlock.LilyPondBlock" [URL="../api/abjadext/book/LilyPondBlock.html#abjadext.book.LilyPondBlock.LilyPondBlock", color=black, fontcolor=white, label="Lily\nPond\nBlock", target=_top]; "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_abjadext.book.directives" { graph [label="abjadext.book.directives"]; node [color=4]; "abjadext.book.directives.AbjadDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.AbjadDirective", color=black, fontcolor=white, label="Abjad\nDirective", target=_top]; "abjadext.book.directives.AbjadDoctestDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.AbjadDoctestDirective", color=black, fontcolor=white, label="Abjad\nDoctest\nDirective", target=_top]; "abjadext.book.directives.ImportDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.ImportDirective", color=black, fontcolor=white, label="Import\nDirective", target=_top]; "abjadext.book.directives.RevealDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.RevealDirective", color=black, fontcolor=white, label="Reveal\nDirective", target=_top]; "abjadext.book.directives.ShellDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.ShellDirective", color=black, fontcolor=white, label="Shell\nDirective", target=_top]; "abjadext.book.directives.ThumbnailDirective" [URL="../api/abjadext/book/directives.html#abjadext.book.directives.ThumbnailDirective", color=black, fontcolor=white, label="Thumbnail\nDirective", target=_top]; } subgraph "cluster_abjadext.book.proxies" { graph [label="abjadext.book.proxies"]; node [color=5]; "abjadext.book.proxies.CodeOutputProxy" [URL="../api/abjadext/book/proxies.html#abjadext.book.proxies.CodeOutputProxy", color=5, label="Code\nOutput\nProxy", target=_top]; "abjadext.book.proxies.GraphvizOutputProxy" [URL="../api/abjadext/book/proxies.html#abjadext.book.proxies.GraphvizOutputProxy", color=5, label="Graphviz\nOutput\nProxy", target=_top]; "abjadext.book.proxies.ImageOutputProxy" [URL="../api/abjadext/book/proxies.html#abjadext.book.proxies.ImageOutputProxy", color=5, label="Image\nOutput\nProxy", shape=oval, style=bold, target=_top]; "abjadext.book.proxies.ImageOutputProxy" -> "abjadext.book.proxies.GraphvizOutputProxy" [minlen=1]; "abjadext.book.proxies.LilyPondOutputProxy" [URL="../api/abjadext/book/proxies.html#abjadext.book.proxies.LilyPondOutputProxy", color=5, label="Lily\nPond\nOutput\nProxy", target=_top]; "abjadext.book.proxies.ImageOutputProxy" -> "abjadext.book.proxies.LilyPondOutputProxy" [minlen=2]; "abjadext.book.proxies.RawLilyPondOutputProxy" [URL="../api/abjadext/book/proxies.html#abjadext.book.proxies.RawLilyPondOutputProxy", color=5, label="Raw\nLily\nPond\nOutput\nProxy", target=_top]; "abjadext.book.proxies.ImageOutputProxy" -> "abjadext.book.proxies.RawLilyPondOutputProxy" [minlen=1]; } subgraph "cluster_abjadext.book.specifiers" { graph [label="abjadext.book.specifiers"]; node [color=6]; "abjadext.book.specifiers.CodeBlockSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.CodeBlockSpecifier", color=6, label="Code\nBlock\nSpecifier", target=_top]; "abjadext.book.specifiers.ImageLayoutSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.ImageLayoutSpecifier", color=6, label="Image\nLayout\nSpecifier", target=_top]; "abjadext.book.specifiers.ImageRenderSpecifier" [URL="../api/abjadext/book/specifiers.html#abjadext.book.specifiers.ImageRenderSpecifier", color=6, label="Image\nRender\nSpecifier", target=_top]; } subgraph cluster_builtins { graph [label=builtins]; node [color=7]; "builtins.BaseException" [URL="https://docs.python.org/3.6/library/exceptions.html#BaseException", color=7, label="Base\nException", target=_top]; "builtins.Exception" [URL="https://docs.python.org/3.6/library/exceptions.html#Exception", color=7, label=Exception, target=_top]; "builtins.BaseException" -> "builtins.Exception" [minlen=1]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", color=7, label=object, target=_top]; "builtins.object" -> "builtins.BaseException" [minlen=1]; } subgraph cluster_code { graph [label=code]; node [color=8]; "code.InteractiveConsole" [URL="https://docs.python.org/3.6/library/code.html#code.InteractiveConsole", color=8, label="Interactive\nConsole", target=_top]; "code.InteractiveInterpreter" [URL="https://docs.python.org/3.6/library/code.html#code.InteractiveInterpreter", color=8, label="Interactive\nInterpreter", target=_top]; "code.InteractiveInterpreter" -> "code.InteractiveConsole" [minlen=1]; } subgraph "cluster_docutils.parsers.rst" { graph [label="docutils.parsers.rst"]; node [color=9]; "docutils.parsers.rst.Directive" [URL="http://www.sphinx-doc.org/en/stable/extdev/markupapi.html#docutils.parsers.rst.Directive", color=9, label=Directive, target=_top]; } subgraph "cluster_uqbar.cli" { graph [label="uqbar.cli"]; node [color=1]; "uqbar.cli.CLI.CLI" [color=1, label=CLI, shape=oval, style=bold]; } "abc.ABC" -> "uqbar.cli.CLI.CLI" [minlen=1]; "abjad.system.AbjadObject.AbjadObject" -> "abjadext.book.SphinxDocumentHandler.SphinxDocumentHandler" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.CodeBlock.CodeBlock" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.LilyPondBlock.LilyPondBlock" [minlen=2]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.proxies.CodeOutputProxy" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.proxies.ImageOutputProxy"; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.specifiers.CodeBlockSpecifier" [minlen=2]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.specifiers.ImageLayoutSpecifier" [minlen=1]; "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjadext.book.specifiers.ImageRenderSpecifier" [minlen=2]; "builtins.Exception" -> "abjadext.book.AbjadBookError" [minlen=1]; "builtins.object" -> "abc.ABC" [minlen=1]; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; "builtins.object" -> "abjadext.book.LaTeXDocumentHandler.LaTeXDocumentHandler" [minlen=2]; "builtins.object" -> "code.InteractiveInterpreter" [minlen=2]; "builtins.object" -> "docutils.parsers.rst.Directive"; "code.InteractiveConsole" -> "abjadext.book.AbjadBookConsole.AbjadBookConsole" [minlen=1]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.AbjadDirective" [minlen=1]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.AbjadDoctestDirective" [minlen=2]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.ImportDirective" [minlen=1]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.RevealDirective" [minlen=2]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.ShellDirective" [minlen=1]; "docutils.parsers.rst.Directive" -> "abjadext.book.directives.ThumbnailDirective" [minlen=2]; "uqbar.cli.CLI.CLI" -> "abjadext.book.AbjadBookScript.AbjadBookScript" [minlen=1]; }


Subpackages

directives
proxies
specifiers
sphinx

Document Handlers

LaTeXDocumentHandler A LaTeX document handler.
SphinxDocumentHandler

Entry Points

AbjadBookScript Entry point script for abjad-book.

Exceptions

AbjadBookError An abjad-book error.
exception abjadext.book.AbjadBookError

An abjad-book error.


Functions

example_function This is a multiline docstring.

Internals

AbjadBookConsole An interactive console which provides a sandboxed namespace for executing abjad-book code examples.
CodeBlock A code block.
LilyPondBlock A LilyPond block.