The infrastructure module: Infrastructure for processing traceables

class sphinxcontrib.traceables.infrastructure.FormatProcessorBase(app, process_node_type=None)

classmethod directive_format_choice(argument)

formatter_defaults = {94549218495040: <sphinxcontrib.traceables.display.TraceableDisplayAdmonitionFormatter object>, 94549218509872: <sphinxcontrib.traceables.list.TableListFormatter object>, 94549218519664: <sphinxcontrib.traceables.matrix.TableMatrixFormatter object>}

formatters = {94549218495040: {'admonition': <sphinxcontrib.traceables.display.TraceableDisplayAdmonitionFormatter object>, 'hidden': <sphinxcontrib.traceables.display.TraceableDisplayHiddenFormatter object>, 'table': <sphinxcontrib.traceables.display.TraceableDisplayTableFormatter object>}, 94549218509872: {'bullets': <sphinxcontrib.traceables.list.BulletListFormatter object>, 'table': <sphinxcontrib.traceables.list.TableListFormatter object>}, 94549218519664: {'columns': <sphinxcontrib.traceables.matrix.TwoColumnMatrixFormatter object>, 'list': <sphinxcontrib.traceables.matrix.BulletMatrixFormatter object>, 'table': <sphinxcontrib.traceables.matrix.TableMatrixFormatter object>}}

classmethod get_default_formatter()

get_formatter(node, name)

classmethod get_registered_formatters()

process_node(node, doctree, docname)

process_node_with_formatter(node, formatter, doctree, docname)

classmethod register_formatter(name, formatter, default=False)

class sphinxcontrib.traceables.infrastructure.InfrastructureLogging

document_warning(env, msg, lineno=None)

node_warning(env, msg, node)

class sphinxcontrib.traceables.infrastructure.ProcessorBase(app, process_node_type=None)

Error

alias of sphinx.errors.ExtensionError

process_doctree(doctree, docname)

process_node(node, doctree, docname)

class sphinxcontrib.traceables.infrastructure.ProcessorManager(app)

process_doctree(doctree, docname)

processor_classes = []

classmethod register_processor_classes(processors)

class sphinxcontrib.traceables.infrastructure.Traceable(target_node, unresolved_tag=None)

has_title()

property is_unresolved

make_reference_node(builder, docname)

classmethod split_tags_string(tags_string)

property title

class sphinxcontrib.traceables.infrastructure.TraceablesFilter(traceables)

filter(expression_string)

traceable_matches(matcher, traceable)

class sphinxcontrib.traceables.infrastructure.TraceablesStorage(env)

add_traceable(node)

analyze_relationship_types()

get_or_create_traceable_by_tag(tag)

get_relationship_direction(name)

get_relationship_opposite(name)

get_traceable_by_tag(tag)

is_valid_relationship(name)

purge(docname)

property traceables_dict

property traceables_set

sphinxcontrib.traceables.infrastructure.add_static_files(app)

sphinxcontrib.traceables.infrastructure.copy_static_files(app, exception)

sphinxcontrib.traceables.infrastructure.process_doctree(app, doctree, docname)

sphinxcontrib.traceables.infrastructure.purge_docname(app, env, docname)

sphinxcontrib.traceables.infrastructure.setup(app)