The matrix module: Matrices of traceables

class sphinxcontrib.traceables.matrix.BulletMatrixFormatter

format(app, docname, node, matrix, options)

class sphinxcontrib.traceables.matrix.MatrixFormatterBase

format(app, docname, node, matrix, options)

class sphinxcontrib.traceables.matrix.MatrixProcessor(app)

build_traceable_matrix(forward, filter1, filter2)

process_node_with_formatter(matrix_node, formatter, doctree, docname)

class sphinxcontrib.traceables.matrix.TableMatrixFormatter

create_cross_table(app, docname, node, matrix, options)

format(app, docname, node, matrix, options)

class sphinxcontrib.traceables.matrix.TraceableMatrix(forward_relationship, backward_relationship)

add_primary(primary)

add_secondary(secondary)

add_traceable_pair(primary, secondary)

ascii_table()

property backward_relationship

calculate_ranges(total_length, max_range_length)

property forward_relationship

get_boolean_row(primary)

get_relatives(primary)

property primaries

property secondaries

split(max_secondaries, max_primaries=None)

class sphinxcontrib.traceables.matrix.TraceableMatrixDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

option_spec = {'filter-primaries': <function unchanged>, 'filter-secondaries': <function unchanged>, 'format': <bound method FormatProcessorBase.directive_format_choice of <class 'sphinxcontrib.traceables.matrix.MatrixProcessor'>>, 'relationship': <function unchanged_required>, 'split-primaries': <function nonnegative_int>, 'split-secondaries': <function nonnegative_int>}

optional_arguments = 0

required_arguments = 0

run()

class sphinxcontrib.traceables.matrix.TwoColumnMatrixFormatter

format(app, docname, node, matrix, options)

sphinxcontrib.traceables.matrix.setup(app)

class sphinxcontrib.traceables.matrix.traceable_checkmark(rawsource='', *children, **attributes)

Placeholder node to be replaced by a builder-specific checkmark symbol.

This node type has no traceable-specific attributes.

class sphinxcontrib.traceables.matrix.traceable_matrix(rawsource='', *children, **attributes)

Placeholder node to be replaced by a traceables matrix.

traceables-relationship

The name of the relationship to display between primary and secondary traceables.

traceables-format

The name of the format with which to display the data.

traceables-filter-primaries

The filter expression to determine which traceables are the primary set.

traceables-filter-secondaries

The filter expression to determine which traceables are the secondary set.

traceables-split-primaries

If set, causes the output to be split after the specified number of primary traceables.

traceables-split-secondaries

If set, causes the output to be split after the specified number of secondary traceables.

class sphinxcontrib.traceables.matrix.traceable_matrix_crosstable(rawsource='', *children, **attributes)

Placeholder node to be replaced by a builder-specific matrix.

traceables-matrix

Instance of TraceableMatrix storing data to be presented in the output.

sphinxcontrib.traceables.matrix.visit_traceable_checkmark_latex(self, node)

sphinxcontrib.traceables.matrix.visit_traceable_matrix_crosstable_latex(self, node)