hawat.blueprints.help package

Description

This pluggable module provides built-in help service.

hawat.blueprints.help.BLUEPRINT_NAME = 'help'

Name of the blueprint as module global constant.

class hawat.blueprints.help.HelpBlueprint(name, import_name, **kwargs)[source]

Bases: hawat.base.HawatBlueprint

Hawat pluggable module - built-in help.

classmethod get_module_title()[source]

Implementation of hawat.base.HawatBlueprint.get_module_title().

class hawat.blueprints.help.ViewView[source]

Bases: hawat.base.HTMLMixin, hawat.base.SimpleView

View responsible for presenting built-in help.

authentication = True
classmethod get_menu_icon()[source]

Implementation of hawat.base.BaseView.get_menu_icon().

classmethod get_menu_title(item=None)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

hawat.blueprints.help.get_blueprint()[source]

Mandatory interface and factory function. This function must return a valid instance of hawat.base.HawatBlueprint or flask.Blueprint.