plantweb.directive

Sphinx directives for rendering PlantUML, Graphviz and Ditaa using Plantweb.

Functions

• setup(): Setup function that makes this module a Sphinx extension.
• builder_inited_handler(): We use this event handler to grab user defaults for Plantweb and use them
• defaults_provider(): Defaults provider that allows to register Sphinx user defaults.

plantweb.directive.setup(app)

Setup function that makes this module a Sphinx extension.

See http://www.sphinx-doc.org/en/stable/extdev/appapi.html#sphinx.application.Sphinx.add_config_value

plantweb.directive.builder_inited_handler(app)

We use this event handler to grab user defaults for Plantweb and use them in Plantweb rendering.

See https://plantweb.readthedocs.io/index.html#overriding-defaults

This is the handler of the ‘builder-inited’ event emitted by Sphinx.

Emitted when the builder object has been created. It is available as app.builder.

See http://www.sphinx-doc.org/en/stable/extdev/appapi.html#event-builder-inited

plantweb.directive.defaults_provider()

Defaults provider that allows to register Sphinx user defaults.

This dummy defaults provider just returns it’s attribute overrides if it exists.

Returns:The dictionary of the form DEFAULT_CONFIG. Return type:dict

Classes

• Plantweb: FIXME: Document.
• UmlDirective: Specialized uml directive for Plantweb Plantweb engine.
• GraphDirective: Specialized graph directive for Plantweb graphviz engine.
• DiagramDirective: Specialized diagram directive for Plantweb ditaa engine.

class plantweb.directive.Plantweb(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

FIXME: Document.

Inheritance

class plantweb.directive.UmlDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Specialized uml directive for Plantweb Plantweb engine.

See Plantweb.

Inheritance

class plantweb.directive.GraphDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Specialized graph directive for Plantweb graphviz engine.

See Plantweb.

Inheritance

class plantweb.directive.DiagramDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Specialized diagram directive for Plantweb ditaa engine.

See Plantweb.

Inheritance