liara.signals

Module Contents

Data

content_filtered	Raised when content has been removed due to a filter.
content_added	Raised when a content node was successfully added.
commandline_prepared	Raised when the command line parsing environment was prepared.
content_discovered	Raised after all content has been discovered.
documents_processed	Raised after all documents have been processed.
document_loaded	Raised after a document has been loaded.
register_markdown_shortcodes	Raised while initializing the Markdown processor.

API

liara.signals.content_filtered = 'signal(...)'

Raised when content has been removed due to a filter.

This signal is raised during the content discovery stage.

Parameters:

• node (liara.nodes.Node) – the node that was removed

• filter (liara.site.ContentFilter) – the filter that matched

liara.signals.content_added = 'signal(...)'

Raised when a content node was successfully added.

This signal is raised during the content discovery stage. It is not raised for nodes that have been filtered.

Parameters:

node (liara.nodes.Node) – the node that was created

liara.signals.commandline_prepared = 'signal(...)'

Raised when the command line parsing environment was prepared.

Parameters:

cli (click.group) – The command line group to add commands to.

liara.signals.content_discovered = 'signal(...)'

Raised after all content has been discovered.

Parameters:

site (liara.site.Site) – the site instance

liara.signals.documents_processed = 'signal(...)'

Raised after all documents have been processed.

Parameters:

site (liara.site.Site) – the site instance

Processing includes the conversion from Markdown to HTML.

liara.signals.document_loaded = 'signal(...)'

Raised after a document has been loaded.

This signal is raised during the content discovery stage.

Parameters:

• document (liara.nodes.DocumentNode) – the document node

• content (str) – the raw document contents

When this signal is raised, the content has been loaded, but no templates etc. have been applied to the document yet.

liara.signals.register_markdown_shortcodes = 'signal(...)'

Raised while initializing the Markdown processor.

Parameters:

preprocessor (liara.md.ShortcodePreprocessor) – The shortcode preprocessor

When this signal is raised, you can register shortcode function calls by calling liara.md.ShortcodePreprocessor.register().