documentationtools


Lineage

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightslategrey, dpi=72, 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_datastructuretools { graph [label=datastructuretools]; "abjad.tools.datastructuretools.TreeContainer.TreeContainer" [color=3, group=2, label=TreeContainer, shape=box]; "abjad.tools.datastructuretools.TreeNode.TreeNode" [color=3, group=2, label=TreeNode, shape=box]; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.datastructuretools.TreeContainer.TreeContainer"; } subgraph cluster_documentationtools { graph [label=documentationtools]; "abjad.tools.documentationtools.DocumentationManager.DocumentationManager" [color=black, fontcolor=white, group=3, label=DocumentationManager, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.InheritanceGraph.InheritanceGraph" [color=black, fontcolor=white, group=3, label=InheritanceGraph, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTAutodocDirective.ReSTAutodocDirective" [color=black, fontcolor=white, group=3, label=ReSTAutodocDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTAutosummaryDirective.ReSTAutosummaryDirective" [color=black, fontcolor=white, group=3, label=ReSTAutosummaryDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTAutosummaryItem.ReSTAutosummaryItem" [color=black, fontcolor=white, group=3, label=ReSTAutosummaryItem, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" [color=black, fontcolor=white, group=3, label=ReSTDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTDocument.ReSTDocument" [color=black, fontcolor=white, group=3, label=ReSTDocument, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTGraphvizDirective.ReSTGraphvizDirective" [color=black, fontcolor=white, group=3, label=ReSTGraphvizDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTHeading.ReSTHeading" [color=black, fontcolor=white, group=3, label=ReSTHeading, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTHorizontalRule.ReSTHorizontalRule" [color=black, fontcolor=white, group=3, label=ReSTHorizontalRule, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTInheritanceDiagram.ReSTInheritanceDiagram" [color=black, fontcolor=white, group=3, label=ReSTInheritanceDiagram, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTLineageDirective.ReSTLineageDirective" [color=black, fontcolor=white, group=3, label=ReSTLineageDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTOnlyDirective.ReSTOnlyDirective" [color=black, fontcolor=white, group=3, label=ReSTOnlyDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTParagraph.ReSTParagraph" [color=black, fontcolor=white, group=3, label=ReSTParagraph, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTTOCDirective.ReSTTOCDirective" [color=black, fontcolor=white, group=3, label=ReSTTOCDirective, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTTOCItem.ReSTTOCItem" [color=black, fontcolor=white, group=3, label=ReSTTOCItem, shape=box, style="filled, rounded"]; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTAutodocDirective.ReSTAutodocDirective"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTAutosummaryDirective.ReSTAutosummaryDirective"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTGraphvizDirective.ReSTGraphvizDirective"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTInheritanceDiagram.ReSTInheritanceDiagram"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTLineageDirective.ReSTLineageDirective"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTOnlyDirective.ReSTOnlyDirective"; "abjad.tools.documentationtools.ReSTDirective.ReSTDirective" -> "abjad.tools.documentationtools.ReSTTOCDirective.ReSTTOCDirective"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.datastructuretools.TreeNode.TreeNode"; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.documentationtools.DocumentationManager.DocumentationManager"; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.documentationtools.InheritanceGraph.InheritanceGraph"; "abjad.tools.datastructuretools.TreeContainer.TreeContainer" -> "abjad.tools.documentationtools.ReSTDirective.ReSTDirective"; "abjad.tools.datastructuretools.TreeContainer.TreeContainer" -> "abjad.tools.documentationtools.ReSTDocument.ReSTDocument"; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.documentationtools.ReSTAutosummaryItem.ReSTAutosummaryItem"; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.documentationtools.ReSTHeading.ReSTHeading"; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.documentationtools.ReSTHorizontalRule.ReSTHorizontalRule"; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.documentationtools.ReSTParagraph.ReSTParagraph"; "abjad.tools.datastructuretools.TreeNode.TreeNode" -> "abjad.tools.documentationtools.ReSTTOCItem.ReSTTOCItem"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }


Documenters

DocumentationManager An API documentation manager.
InheritanceGraph Generates a graph of a class or collection of

reStructuredText

ReSTAutodocDirective A ReST autodoc directive.
ReSTAutosummaryDirective A ReST Autosummary directive.
ReSTAutosummaryItem A ReST autosummary item.
ReSTDirective A ReST directive.
ReSTDocument A ReST document tree.
ReSTGraphvizDirective A ReST Graphviz directive.
ReSTHeading A ReST heading.
ReSTHorizontalRule A ReST horizontal rule.
ReSTInheritanceDiagram A ReST inheritance diagram directive.
ReSTLineageDirective A ReST lineage directive.
ReSTOnlyDirective A ReST only directive.
ReSTParagraph A ReST paragraph.
ReSTTOCDirective A ReST TOC directive.
ReSTTOCItem A ReST TOC item.

Functions

compare_images Compare image_one against image_two using ImageMagick’s compare commandline tool.
list_all_abjad_classes Lists all public classes defined in Abjad.
list_all_abjad_functions Lists all public functions defined in Abjad.
list_all_classes Lists all public classes defined in path.
list_all_experimental_classes Lists all public classes defined in the Abjad experimental branch.
list_all_functions Lists all public functions defined in modules.
list_all_ide_classes Lists all public classes defined in Abjad IDE.
list_all_ide_functions Lists all public functions defined in Abjad IDE.
make_ligeti_example_lilypond_file Makes Ligeti example LilyPond file.
make_reference_manual_graphviz_graph Make a GraphvizGraph instance suitable for use in the Abjad reference manual.
make_reference_manual_lilypond_file Makes reference manual LilyPond file.
make_text_alignment_example_lilypond_file Makes text-alignment example LilyPond file.
yield_all_classes Yields all classes encountered in code_root.
yield_all_functions Yields all functions in code_root.
yield_all_modules Yields all modules encountered in code_root whose name begins with `root_package_name.