The traceables
module: Core traceables functionality¶
-
class
sphinxcontrib.traceables.traceables.
DefaultDict
(default)¶
-
class
sphinxcontrib.traceables.traceables.
RelationshipsProcessor
(app, process_node_type=None)¶ -
process_doctree
(doctree, docname)¶
-
-
class
sphinxcontrib.traceables.traceables.
TraceableDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)¶ -
create_index_node
(env, tag, attributes)¶
-
create_target_node
(env, tag, attributes)¶
-
final_argument_whitespace
= False¶
-
has_content
= True¶
-
option_spec
= {}¶
-
optional_arguments
= 0¶
-
required_arguments
= 1¶
-
run
()¶
-
-
class
sphinxcontrib.traceables.traceables.
XrefProcessor
(app, process_node_type=None)¶ -
process_doctree
(doctree, docname)¶
-
-
sphinxcontrib.traceables.traceables.
setup
(app)¶
-
class
sphinxcontrib.traceables.traceables.
traceable_xref
(rawsource='', *children, **attributes)¶